Skip to content

Commit

Permalink
Promote NIMS package version and update Sphinx generated files in _docs
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Oct 28, 2022
1 parent 8fd691e commit ebe06a8
Show file tree
Hide file tree
Showing 110 changed files with 2,574 additions and 2,969 deletions.
2 changes: 1 addition & 1 deletion docs/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 541db7e38e2883eda2bbbf86b8ea6347
config: 96e973b27acd0c9d53d7599b0dd8cce2
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/.doctrees/autoapi/ni_measurement_service/index.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/.doctrees/environment.pickle
Binary file not shown.
15 changes: 6 additions & 9 deletions docs/_modules/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Overview: module code &mdash; ni_measurement_service 0.9 documentation</title>
<title>Overview: module code &mdash; ni_measurement_service 0.10 documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/graphviz.css" type="text/css" />
Expand All @@ -30,7 +30,7 @@
<a href="../index.html" class="icon icon-home"> ni_measurement_service
</a>
<div class="version">
0.9.2
0.10.1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
Expand Down Expand Up @@ -68,20 +68,17 @@
<div itemprop="articleBody">

<h1>All modules for which code is available</h1>
<ul><li><a href="DiscoveryServices_pb2.html">DiscoveryServices_pb2</a></li>
<li><a href="Measurement_pb2.html">Measurement_pb2</a></li>
<li><a href="ServiceLocation_pb2.html">ServiceLocation_pb2</a></li>
<li><a href="ServiceManagement_pb2.html">ServiceManagement_pb2</a></li>
<ul><li><a href="ni/measurements/discovery/v1/discovery_service_pb2.html">ni.measurements.discovery.v1.discovery_service_pb2</a></li>
<li><a href="ni/measurements/measurementservice/measurement_service_pb2.html">ni.measurements.measurementservice.measurement_service_pb2</a></li>
<li><a href="ni/measurements/pin_map_context_pb2.html">ni.measurements.pin_map_context_pb2</a></li>
<li><a href="ni_measurement_service/_internal/discovery_client.html">ni_measurement_service._internal.discovery_client</a></li>
<li><a href="ni_measurement_service/_internal/grpc_servicer.html">ni_measurement_service._internal.grpc_servicer</a></li>
<li><a href="ni_measurement_service/_internal/parameter/metadata.html">ni_measurement_service._internal.parameter.metadata</a></li>
<li><a href="ni_measurement_service/_internal/parameter/serialization_strategy.html">ni_measurement_service._internal.parameter.serialization_strategy</a></li>
<li><a href="ni_measurement_service/_internal/parameter/serializer.html">ni_measurement_service._internal.parameter.serializer</a></li>
<li><a href="ni_measurement_service/_internal/service_manager.html">ni_measurement_service._internal.service_manager</a></li>
<li><a href="ni_measurement_service/_internal/stubs/DiscoveryServices_pb2_grpc.html">ni_measurement_service._internal.stubs.DiscoveryServices_pb2_grpc</a></li>
<li><a href="ni_measurement_service/_internal/stubs/Measurement_pb2_grpc.html">ni_measurement_service._internal.stubs.Measurement_pb2_grpc</a></li>
<li><a href="ni_measurement_service/_internal/utilities/console_exit_functions.html">ni_measurement_service._internal.utilities.console_exit_functions</a></li>
<li><a href="ni_measurement_service/_internal/stubs/ni/measurements/discovery/v1/discovery_service_pb2_grpc.html">ni_measurement_service._internal.stubs.ni.measurements.discovery.v1.discovery_service_pb2_grpc</a></li>
<li><a href="ni_measurement_service/_internal/stubs/ni/measurements/measurementservice/measurement_service_pb2_grpc.html">ni_measurement_service._internal.stubs.ni.measurements.measurementservice.measurement_service_pb2_grpc</a></li>
<li><a href="ni_measurement_service/measurement/info.html">ni_measurement_service.measurement.info</a></li>
<li><a href="ni_measurement_service/measurement/service.html">ni_measurement_service.measurement.service</a></li>
</ul>
Expand Down
163 changes: 133 additions & 30 deletions docs/_modules/ni_measurement_service/_internal/discovery_client.html

Large diffs are not rendered by default.

78 changes: 45 additions & 33 deletions docs/_modules/ni_measurement_service/_internal/grpc_servicer.html

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>ni_measurement_service._internal.parameter.metadata &mdash; ni_measurement_service 0.9 documentation</title>
<title>ni_measurement_service._internal.parameter.metadata &mdash; ni_measurement_service 0.10 documentation</title>
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/graphviz.css" type="text/css" />
Expand All @@ -30,7 +30,7 @@
<a href="../../../../index.html" class="icon icon-home"> ni_measurement_service
</a>
<div class="version">
0.9.2
0.10.1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
Expand Down Expand Up @@ -96,7 +96,7 @@ <h1>Source code for ni_measurement_service._internal.parameter.metadata</h1><div
<span class="sd"> &quot;&quot;&quot;</span>

<span class="n">display_name</span><span class="p">:</span> <span class="nb">str</span>
<span class="nb">type</span><span class="p">:</span> <span class="n">type_pb2</span><span class="o">.</span><span class="n">Field</span>
<span class="nb">type</span><span class="p">:</span> <span class="n">type_pb2</span><span class="o">.</span><span class="n">Field</span><span class="o">.</span><span class="n">Kind</span><span class="o">.</span><span class="n">ValueType</span>
<span class="n">repeated</span><span class="p">:</span> <span class="nb">bool</span>
<span class="n">default_value</span><span class="p">:</span> <span class="n">Any</span></div>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>ni_measurement_service._internal.parameter.serialization_strategy &mdash; ni_measurement_service 0.9 documentation</title>
<title>ni_measurement_service._internal.parameter.serialization_strategy &mdash; ni_measurement_service 0.10 documentation</title>
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/graphviz.css" type="text/css" />
Expand All @@ -30,7 +30,7 @@
<a href="../../../../index.html" class="icon icon-home"> ni_measurement_service
</a>
<div class="version">
0.9.2
0.10.1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
Expand Down Expand Up @@ -246,12 +246,14 @@ <h1>Source code for ni_measurement_service._internal.parameter.serialization_str
<span class="p">}</span>

<div class="viewcode-block" id="Context.get_encoder"><a class="viewcode-back" href="../../../../autoapi/ni_measurement_service/_internal/parameter/serialization_strategy/index.html#ni_measurement_service._internal.parameter.serialization_strategy.Context.get_encoder">[docs]</a> <span class="nd">@staticmethod</span>
<span class="k">def</span> <span class="nf">get_encoder</span><span class="p">(</span><span class="nb">type</span><span class="p">:</span> <span class="n">type_pb2</span><span class="o">.</span><span class="n">Field</span><span class="p">,</span> <span class="n">repeated</span><span class="p">:</span> <span class="nb">bool</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Callable</span><span class="p">[[</span><span class="nb">int</span><span class="p">],</span> <span class="n">Callable</span><span class="p">]:</span>
<span class="k">def</span> <span class="nf">get_encoder</span><span class="p">(</span>
<span class="nb">type</span><span class="p">:</span> <span class="n">type_pb2</span><span class="o">.</span><span class="n">Field</span><span class="o">.</span><span class="n">Kind</span><span class="o">.</span><span class="n">ValueType</span><span class="p">,</span> <span class="n">repeated</span><span class="p">:</span> <span class="nb">bool</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Callable</span><span class="p">[[</span><span class="nb">int</span><span class="p">],</span> <span class="n">Callable</span><span class="p">]:</span>
<span class="sd">&quot;&quot;&quot;Get the Scalar Encoder or Vector Encoder for the specified type based on repeated bool.</span>

<span class="sd"> Args</span>
<span class="sd"> ----</span>
<span class="sd"> type (type_pb2.Field): Type of the Parameter.</span>
<span class="sd"> type (type_pb2.Field.Kind.ValueType): Type of the Parameter.</span>

<span class="sd"> repeated (bool): Boolean that represents if the Parameter is repeated or not.</span>

Expand All @@ -266,18 +268,20 @@ <h1>Source code for ni_measurement_service._internal.parameter.serialization_str
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="nb">type</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">Context</span><span class="o">.</span><span class="n">_FIELD_TYPE_TO_ENCODER_MAPPING</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Error can not encode type &#39;</span><span class="si">{</span><span class="nb">type</span><span class="si">}</span><span class="s2">&#39;&quot;</span><span class="p">)</span>
<span class="n">scalar</span><span class="p">,</span> <span class="n">array</span> <span class="o">=</span> <span class="n">Context</span><span class="o">.</span><span class="n">_FIELD_TYPE_TO_ENCODER_MAPPING</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="nb">type</span><span class="p">)</span> <span class="c1"># type: ignore[call-overload]</span>
<span class="n">scalar</span><span class="p">,</span> <span class="n">array</span> <span class="o">=</span> <span class="n">Context</span><span class="o">.</span><span class="n">_FIELD_TYPE_TO_ENCODER_MAPPING</span><span class="p">[</span><span class="nb">type</span><span class="p">]</span>
<span class="k">if</span> <span class="n">repeated</span><span class="p">:</span>
<span class="k">return</span> <span class="n">array</span>
<span class="k">return</span> <span class="n">scalar</span></div>

<div class="viewcode-block" id="Context.get_decoder"><a class="viewcode-back" href="../../../../autoapi/ni_measurement_service/_internal/parameter/serialization_strategy/index.html#ni_measurement_service._internal.parameter.serialization_strategy.Context.get_decoder">[docs]</a> <span class="nd">@staticmethod</span>
<span class="k">def</span> <span class="nf">get_decoder</span><span class="p">(</span><span class="nb">type</span><span class="p">:</span> <span class="n">type_pb2</span><span class="o">.</span><span class="n">Field</span><span class="p">,</span> <span class="n">repeated</span><span class="p">:</span> <span class="nb">bool</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Callable</span><span class="p">[[</span><span class="nb">int</span><span class="p">,</span> <span class="nb">str</span><span class="p">],</span> <span class="n">Callable</span><span class="p">]:</span>
<span class="k">def</span> <span class="nf">get_decoder</span><span class="p">(</span>
<span class="nb">type</span><span class="p">:</span> <span class="n">type_pb2</span><span class="o">.</span><span class="n">Field</span><span class="o">.</span><span class="n">Kind</span><span class="o">.</span><span class="n">ValueType</span><span class="p">,</span> <span class="n">repeated</span><span class="p">:</span> <span class="nb">bool</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Callable</span><span class="p">[[</span><span class="nb">int</span><span class="p">,</span> <span class="nb">str</span><span class="p">],</span> <span class="n">Callable</span><span class="p">]:</span>
<span class="sd">&quot;&quot;&quot;Get the Scalar Decoder or Vector Decoder for the specified type based on repeated bool.</span>

<span class="sd"> Args</span>
<span class="sd"> ----</span>
<span class="sd"> type (type_pb2.Field): Type of the Parameter.</span>
<span class="sd"> type (type_pb2.Field.Kind.ValueType): Type of the Parameter.</span>

<span class="sd"> repeated (bool): Boolean that represents if the Parameter is repeated or not.</span>

Expand All @@ -292,18 +296,18 @@ <h1>Source code for ni_measurement_service._internal.parameter.serialization_str
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="nb">type</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">Context</span><span class="o">.</span><span class="n">_FIELD_TYPE_TO_DECODER_MAPPING</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Error can not decode type &#39;</span><span class="si">{</span><span class="nb">type</span><span class="si">}</span><span class="s2">&#39;&quot;</span><span class="p">)</span>
<span class="n">scalar</span><span class="p">,</span> <span class="n">array</span> <span class="o">=</span> <span class="n">Context</span><span class="o">.</span><span class="n">_FIELD_TYPE_TO_DECODER_MAPPING</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="nb">type</span><span class="p">)</span> <span class="c1"># type: ignore[call-overload]</span>
<span class="n">scalar</span><span class="p">,</span> <span class="n">array</span> <span class="o">=</span> <span class="n">Context</span><span class="o">.</span><span class="n">_FIELD_TYPE_TO_DECODER_MAPPING</span><span class="p">[</span><span class="nb">type</span><span class="p">]</span>
<span class="k">if</span> <span class="n">repeated</span><span class="p">:</span>
<span class="k">return</span> <span class="n">array</span>
<span class="k">return</span> <span class="n">scalar</span></div>

<div class="viewcode-block" id="Context.get_type_default"><a class="viewcode-back" href="../../../../autoapi/ni_measurement_service/_internal/parameter/serialization_strategy/index.html#ni_measurement_service._internal.parameter.serialization_strategy.Context.get_type_default">[docs]</a> <span class="nd">@staticmethod</span>
<span class="k">def</span> <span class="nf">get_type_default</span><span class="p">(</span><span class="nb">type</span><span class="p">:</span> <span class="n">type_pb2</span><span class="o">.</span><span class="n">Field</span><span class="p">,</span> <span class="n">repeated</span><span class="p">:</span> <span class="nb">bool</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Any</span><span class="p">:</span>
<span class="k">def</span> <span class="nf">get_type_default</span><span class="p">(</span><span class="nb">type</span><span class="p">:</span> <span class="n">type_pb2</span><span class="o">.</span><span class="n">Field</span><span class="o">.</span><span class="n">Kind</span><span class="o">.</span><span class="n">ValueType</span><span class="p">,</span> <span class="n">repeated</span><span class="p">:</span> <span class="nb">bool</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Any</span><span class="p">:</span>
<span class="sd">&quot;&quot;&quot;Get the Type default.</span>

<span class="sd"> Args</span>
<span class="sd"> ----</span>
<span class="sd"> type (type_pb2.Field): Type of the Parameter.</span>
<span class="sd"> type (type_pb2.Field.Kind.ValueType): Type of the Parameter.</span>

<span class="sd"> repeated (bool): Boolean that represents if the Parameter is repeated or not.</span>

Expand All @@ -314,7 +318,7 @@ <h1>Source code for ni_measurement_service._internal.parameter.serialization_str
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="n">repeated</span><span class="p">:</span>
<span class="k">return</span> <span class="nb">list</span><span class="p">()</span>
<span class="n">type_default_value</span> <span class="o">=</span> <span class="n">Context</span><span class="o">.</span><span class="n">_TYPE_DEFAULT_MAPPING</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="nb">type</span><span class="p">)</span> <span class="c1"># type: ignore[call-overload]</span>
<span class="n">type_default_value</span> <span class="o">=</span> <span class="n">Context</span><span class="o">.</span><span class="n">_TYPE_DEFAULT_MAPPING</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="nb">type</span><span class="p">)</span>
<span class="k">return</span> <span class="n">type_default_value</span></div></div>
</pre></div>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>ni_measurement_service._internal.parameter.serializer &mdash; ni_measurement_service 0.9 documentation</title>
<title>ni_measurement_service._internal.parameter.serializer &mdash; ni_measurement_service 0.10 documentation</title>
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/graphviz.css" type="text/css" />
Expand All @@ -30,7 +30,7 @@
<a href="../../../../index.html" class="icon icon-home"> ni_measurement_service
</a>
<div class="version">
0.9.2
0.10.1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
Expand Down
Loading

0 comments on commit ebe06a8

Please sign in to comment.