diff --git a/.gitignore b/.gitignore index f326a7e6..1a0bf48e 100644 --- a/.gitignore +++ b/.gitignore @@ -14,7 +14,7 @@ htmlcov/ # Built artifacts dist/ -docs/_build/ +**/docs/**/_build/ # mypy .mypy_cache/ diff --git a/packages/ni.grpcdevice.v1.proto/docs/conf.py b/packages/ni.grpcdevice.v1.proto/docs/conf.py index 6519caf0..af5ce7ce 100644 --- a/packages/ni.grpcdevice.v1.proto/docs/conf.py +++ b/packages/ni.grpcdevice.v1.proto/docs/conf.py @@ -10,6 +10,7 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ + "autoapi.extension", "m2r2", "sphinx.ext.autodoc", "sphinx.ext.intersphinx", @@ -44,18 +45,16 @@ # tell autoapi to doc the public options autoapi_options = list(autoapi.extension._DEFAULT_OPTIONS) autoapi_options.remove("private-members") # note: remove this to include "_" members in docs -# Restore this to start building docs for source again -# AB#3233030 -# autoapi_dirs = [root_path / "src" / "ni"] +autoapi_dirs = [ + root_path / "src" / "session_pb2", + root_path / "src" / "session_pb2_grpc", +] autoapi_python_use_implicit_namespaces = True autoapi_template_dir = "templates/autoapi" autoapi_python_class_content = "both" autoapi_type = "python" autodoc_typehints = "description" autoapi_file_patterns = ["*.pyi", "*.py"] -autoapi_ignore = [ - '**/__init__.py', -] def process_docstring(app, what, name, obj, options, lines): @@ -66,7 +65,7 @@ def process_docstring(app, what, name, obj, options, lines): def setup(sphinx): """Sphinx setup callback.""" - # sphinx.connect("autodoc-process-docstring", process_docstring) + sphinx.connect("autodoc-process-docstring", process_docstring) # List of patterns, relative to source directory, that match files and @@ -76,6 +75,7 @@ def setup(sphinx): intersphinx_mapping = { "python": ("https://docs.python.org/3", None), + "protobuf": ("https://googleapis.dev/python/protobuf/latest/", None), } diff --git a/packages/ni.grpcdevice.v1.proto/docs/index.rst b/packages/ni.grpcdevice.v1.proto/docs/index.rst index e8c792c5..e495fd82 100644 --- a/packages/ni.grpcdevice.v1.proto/docs/index.rst +++ b/packages/ni.grpcdevice.v1.proto/docs/index.rst @@ -2,7 +2,20 @@ Protobuf Types for NI grpc-device V1 gRPC APIs ############################################## +.. include:: intro.inc + +Table of Contents +================= + .. toctree:: - :maxdepth: 1 - :caption: Contents: + :maxdepth: 4 + + autoapi/index + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/packages/ni.measurementlink.discovery.v1.client/docs/conf.py b/packages/ni.measurementlink.discovery.v1.client/docs/conf.py index 68da6a0d..3efe084a 100644 --- a/packages/ni.measurementlink.discovery.v1.client/docs/conf.py +++ b/packages/ni.measurementlink.discovery.v1.client/docs/conf.py @@ -10,6 +10,7 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ + "autoapi.extension", "m2r2", "sphinx.ext.autodoc", "sphinx.ext.intersphinx", @@ -51,14 +52,16 @@ autoapi_type = "python" autodoc_typehints = "description" autoapi_file_patterns = ["*.py"] -autoapi_ignore = [ - '**/__init__.py', -] +def process_docstring(app, what, name, obj, options, lines): + """Make edits to docstrings as necessary""" + if r"@generated by mypy-protobuf" in lines[0]: + lines.clear() + def setup(sphinx): """Sphinx setup callback.""" - pass + sphinx.connect("autodoc-process-docstring", process_docstring) # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. diff --git a/packages/ni.measurementlink.discovery.v1.client/docs/index.rst b/packages/ni.measurementlink.discovery.v1.client/docs/index.rst index e3e779ab..31802f9d 100644 --- a/packages/ni.measurementlink.discovery.v1.client/docs/index.rst +++ b/packages/ni.measurementlink.discovery.v1.client/docs/index.rst @@ -2,7 +2,20 @@ gRPC Client for NI Discovery Service #################################### +.. include:: intro.inc + +Table of Contents +================= + .. toctree:: - :maxdepth: 1 - :caption: Contents: + :maxdepth: 4 + + autoapi/index + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/packages/ni.measurementlink.discovery.v1.client/docs/templates/autoapi/index.rst b/packages/ni.measurementlink.discovery.v1.client/docs/templates/autoapi/index.rst new file mode 100644 index 00000000..3276ba24 --- /dev/null +++ b/packages/ni.measurementlink.discovery.v1.client/docs/templates/autoapi/index.rst @@ -0,0 +1,19 @@ +API Reference +============= + +This page contains auto-generated API reference documentation. + +.. + Custom index: reference https://github.com/readthedocs/sphinx-autoapi/issues/298 + Add the top most levels in "ni.measurementlink.discovery.v1.client" to the index file + This is needed because we don't have __init__.py file in ni + and ni/measurementlink etc. package as we use nested implicit namespace packages. + +.. toctree:: + :titlesonly: + + {% for page in pages | sort %} + {% if (page.top_level_object or page.name.split('.') | length == 5) and page.display %} + {{ page.include_path }} + {% endif %} + {% endfor %} diff --git a/packages/ni.measurementlink.discovery.v1.client/src/ni/measurementlink/discovery/v1/client/_client.py b/packages/ni.measurementlink.discovery.v1.client/src/ni/measurementlink/discovery/v1/client/_client.py index 64071078..ddcbcd36 100644 --- a/packages/ni.measurementlink.discovery.v1.client/src/ni/measurementlink/discovery/v1/client/_client.py +++ b/packages/ni.measurementlink.discovery.v1.client/src/ni/measurementlink/discovery/v1/client/_client.py @@ -7,7 +7,8 @@ from collections.abc import Sequence import grpc -from ni.measurementlink.discovery.v1 import discovery_service_pb2, discovery_service_pb2_grpc +import ni.measurementlink.discovery.v1.discovery_service_pb2 as discovery_service_pb2 +import ni.measurementlink.discovery.v1.discovery_service_pb2_grpc as discovery_service_pb2_grpc from ni_grpc_extensions.channelpool import GrpcChannelPool # type: ignore[import-untyped] from ni.measurementlink.discovery.v1.client._support import ( diff --git a/packages/ni.measurementlink.discovery.v1.client/src/ni/measurementlink/discovery/v1/client/_support.py b/packages/ni.measurementlink.discovery.v1.client/src/ni/measurementlink/discovery/v1/client/_support.py index d40724b1..feb7e684 100644 --- a/packages/ni.measurementlink.discovery.v1.client/src/ni/measurementlink/discovery/v1/client/_support.py +++ b/packages/ni.measurementlink.discovery.v1.client/src/ni/measurementlink/discovery/v1/client/_support.py @@ -12,9 +12,8 @@ import typing from typing import Any -from ni.measurementlink.discovery.v1 import ( - discovery_service_pb2, -) +import ni.measurementlink.discovery.v1.discovery_service_pb2 as discovery_service_pb2 + if sys.platform == "win32": import msvcrt diff --git a/packages/ni.measurementlink.discovery.v1.client/src/ni/measurementlink/discovery/v1/client/_types.py b/packages/ni.measurementlink.discovery.v1.client/src/ni/measurementlink/discovery/v1/client/_types.py index feb1f283..80378161 100644 --- a/packages/ni.measurementlink.discovery.v1.client/src/ni/measurementlink/discovery/v1/client/_types.py +++ b/packages/ni.measurementlink.discovery.v1.client/src/ni/measurementlink/discovery/v1/client/_types.py @@ -5,9 +5,7 @@ import typing from typing import NamedTuple -from ni.measurementlink.discovery.v1 import ( - discovery_service_pb2, -) +import ni.measurementlink.discovery.v1.discovery_service_pb2 as discovery_service_pb2 class ServiceInfo(NamedTuple): diff --git a/packages/ni.measurementlink.discovery.v1.proto/docs/conf.py b/packages/ni.measurementlink.discovery.v1.proto/docs/conf.py index ab7eb850..8f5f72d1 100644 --- a/packages/ni.measurementlink.discovery.v1.proto/docs/conf.py +++ b/packages/ni.measurementlink.discovery.v1.proto/docs/conf.py @@ -10,6 +10,7 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ + "autoapi.extension", "m2r2", "sphinx.ext.autodoc", "sphinx.ext.intersphinx", @@ -44,18 +45,13 @@ # tell autoapi to doc the public options autoapi_options = list(autoapi.extension._DEFAULT_OPTIONS) autoapi_options.remove("private-members") # note: remove this to include "_" members in docs -# Restore this to start building docs for source again -# AB#3233030 -# autoapi_dirs = [root_path / "src" / "ni"] +autoapi_dirs = [root_path / "src" / "ni"] autoapi_python_use_implicit_namespaces = True autoapi_template_dir = "templates/autoapi" autoapi_python_class_content = "both" autoapi_type = "python" autodoc_typehints = "description" autoapi_file_patterns = ["*.pyi", "*.py"] -autoapi_ignore = [ - '**/__init__.py', -] def process_docstring(app, what, name, obj, options, lines): @@ -66,15 +62,17 @@ def process_docstring(app, what, name, obj, options, lines): def setup(sphinx): """Sphinx setup callback.""" - pass + sphinx.connect("autodoc-process-docstring", process_docstring) # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This patterns also effect to html_static_path and html_extra_path -exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "__init__.py"] +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] intersphinx_mapping = { "python": ("https://docs.python.org/3", None), + "protobuf": ("https://googleapis.dev/python/protobuf/latest/", None), + "grpc": ("https://grpc.github.io/grpc/python/", None), } # -- Options for HTML output ---------------------------------------------- diff --git a/packages/ni.measurementlink.discovery.v1.proto/docs/index.rst b/packages/ni.measurementlink.discovery.v1.proto/docs/index.rst index 68a5b9de..dd2b92d5 100644 --- a/packages/ni.measurementlink.discovery.v1.proto/docs/index.rst +++ b/packages/ni.measurementlink.discovery.v1.proto/docs/index.rst @@ -2,7 +2,19 @@ Protobuf Types for NI Discovery gRPC APIs ######################################### +.. include:: intro.inc + +Table of Contents +================= + .. toctree:: - :maxdepth: 1 - :caption: Contents: + :maxdepth: 4 + + autoapi/index + +Indices and tables +================== +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/packages/ni.measurementlink.discovery.v1.proto/docs/namespace.rst b/packages/ni.measurementlink.discovery.v1.proto/docs/namespace.rst new file mode 100644 index 00000000..7fe19c7e --- /dev/null +++ b/packages/ni.measurementlink.discovery.v1.proto/docs/namespace.rst @@ -0,0 +1,19 @@ +ni.measurementlink.discovery.v1 +=============================== + +.. py:module:: ni.measurementlink.discovery.v1 + +.. autoapi-nested-parse:: + + Package for ni.measurementlink.discovery.v1. + + + +Submodules +---------- + +.. toctree:: + :maxdepth: 1 + + /autoapi/ni/measurementlink/discovery/v1/discovery_service_pb2/index + /autoapi/ni/measurementlink/discovery/v1/discovery_service_pb2_grpc/index \ No newline at end of file diff --git a/packages/ni.measurementlink.discovery.v1.proto/docs/templates/autoapi/index.rst b/packages/ni.measurementlink.discovery.v1.proto/docs/templates/autoapi/index.rst new file mode 100644 index 00000000..458feb09 --- /dev/null +++ b/packages/ni.measurementlink.discovery.v1.proto/docs/templates/autoapi/index.rst @@ -0,0 +1,13 @@ +API Reference +============= + +This page contains auto-generated API reference documentation. + +.. + Custom index: reference https://github.com/readthedocs/sphinx-autoapi/issues/298 + Add the deepest implicit namespace package to the toctree. + +.. toctree:: + :titlesonly: + + /namespace \ No newline at end of file diff --git a/packages/ni.measurementlink.measurement.v1.proto/docs/conf.py b/packages/ni.measurementlink.measurement.v1.proto/docs/conf.py index 6519caf0..7d05947f 100644 --- a/packages/ni.measurementlink.measurement.v1.proto/docs/conf.py +++ b/packages/ni.measurementlink.measurement.v1.proto/docs/conf.py @@ -10,6 +10,7 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ + "autoapi.extension", "m2r2", "sphinx.ext.autodoc", "sphinx.ext.intersphinx", @@ -44,18 +45,13 @@ # tell autoapi to doc the public options autoapi_options = list(autoapi.extension._DEFAULT_OPTIONS) autoapi_options.remove("private-members") # note: remove this to include "_" members in docs -# Restore this to start building docs for source again -# AB#3233030 -# autoapi_dirs = [root_path / "src" / "ni"] +autoapi_dirs = [root_path / "src" / "ni"] autoapi_python_use_implicit_namespaces = True autoapi_template_dir = "templates/autoapi" autoapi_python_class_content = "both" autoapi_type = "python" autodoc_typehints = "description" autoapi_file_patterns = ["*.pyi", "*.py"] -autoapi_ignore = [ - '**/__init__.py', -] def process_docstring(app, what, name, obj, options, lines): @@ -66,16 +62,18 @@ def process_docstring(app, what, name, obj, options, lines): def setup(sphinx): """Sphinx setup callback.""" - # sphinx.connect("autodoc-process-docstring", process_docstring) + sphinx.connect("autodoc-process-docstring", process_docstring) # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This patterns also effect to html_static_path and html_extra_path -exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "__init__.py"] +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] intersphinx_mapping = { "python": ("https://docs.python.org/3", None), + "protobuf": ("https://googleapis.dev/python/protobuf/latest/", None), + "grpc": ("https://grpc.github.io/grpc/python/", None), } diff --git a/packages/ni.measurementlink.measurement.v1.proto/docs/index.rst b/packages/ni.measurementlink.measurement.v1.proto/docs/index.rst index 9d06b5e2..edffb915 100644 --- a/packages/ni.measurementlink.measurement.v1.proto/docs/index.rst +++ b/packages/ni.measurementlink.measurement.v1.proto/docs/index.rst @@ -2,7 +2,19 @@ Protobuf Types for NI Measurement V1 gRPC APIs ############################################## +.. include:: intro.inc + +Table of Contents +================= + .. toctree:: - :maxdepth: 1 - :caption: Contents: + :maxdepth: 4 + + autoapi/index + +Indices and tables +================== +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/packages/ni.measurementlink.measurement.v1.proto/docs/namespace.rst b/packages/ni.measurementlink.measurement.v1.proto/docs/namespace.rst new file mode 100644 index 00000000..e2fdd2a6 --- /dev/null +++ b/packages/ni.measurementlink.measurement.v1.proto/docs/namespace.rst @@ -0,0 +1,19 @@ +ni.measurementlink.measurement.v1 +================================= + +.. py:module:: ni.measurementlink.measurement.v1 + +.. autoapi-nested-parse:: + + Package for ni.measurementlink.measurement.v1. + + + +Submodules +---------- + +.. toctree:: + :maxdepth: 1 + + /autoapi/ni/measurementlink/measurement/v1/measurement_service_pb2/index + /autoapi/ni/measurementlink/measurement/v1/measurement_service_pb2_grpc/index \ No newline at end of file diff --git a/packages/ni.measurementlink.measurement.v1.proto/docs/templates/autoapi/index.rst b/packages/ni.measurementlink.measurement.v1.proto/docs/templates/autoapi/index.rst new file mode 100644 index 00000000..458feb09 --- /dev/null +++ b/packages/ni.measurementlink.measurement.v1.proto/docs/templates/autoapi/index.rst @@ -0,0 +1,13 @@ +API Reference +============= + +This page contains auto-generated API reference documentation. + +.. + Custom index: reference https://github.com/readthedocs/sphinx-autoapi/issues/298 + Add the deepest implicit namespace package to the toctree. + +.. toctree:: + :titlesonly: + + /namespace \ No newline at end of file diff --git a/packages/ni.measurementlink.measurement.v2.proto/docs/conf.py b/packages/ni.measurementlink.measurement.v2.proto/docs/conf.py index 4e07e94d..7d05947f 100644 --- a/packages/ni.measurementlink.measurement.v2.proto/docs/conf.py +++ b/packages/ni.measurementlink.measurement.v2.proto/docs/conf.py @@ -10,12 +10,12 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - # "autoapi.extension", - # "m2r2", - # "sphinx.ext.autodoc", - # "sphinx.ext.intersphinx", - # "sphinx.ext.napoleon", - # "sphinx.ext.viewcode", + "autoapi.extension", + "m2r2", + "sphinx.ext.autodoc", + "sphinx.ext.intersphinx", + "sphinx.ext.napoleon", + "sphinx.ext.viewcode", ] root_path = pathlib.Path(__file__).parent.parent @@ -45,16 +45,13 @@ # tell autoapi to doc the public options autoapi_options = list(autoapi.extension._DEFAULT_OPTIONS) autoapi_options.remove("private-members") # note: remove this to include "_" members in docs -# autoapi_dirs = [root_path / "src" / "ni"] +autoapi_dirs = [root_path / "src" / "ni"] autoapi_python_use_implicit_namespaces = True autoapi_template_dir = "templates/autoapi" autoapi_python_class_content = "both" autoapi_type = "python" autodoc_typehints = "description" autoapi_file_patterns = ["*.pyi", "*.py"] -autoapi_ignore = [ - '**/__init__.py', -] def process_docstring(app, what, name, obj, options, lines): @@ -65,17 +62,19 @@ def process_docstring(app, what, name, obj, options, lines): def setup(sphinx): """Sphinx setup callback.""" - # sphinx.connect("autodoc-process-docstring", process_docstring) + sphinx.connect("autodoc-process-docstring", process_docstring) # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This patterns also effect to html_static_path and html_extra_path -exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "__init__.py"] +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] -# intersphinx_mapping = { - # "python": ("https://docs.python.org/3", None), -# } +intersphinx_mapping = { + "python": ("https://docs.python.org/3", None), + "protobuf": ("https://googleapis.dev/python/protobuf/latest/", None), + "grpc": ("https://grpc.github.io/grpc/python/", None), +} # -- Options for HTML output ---------------------------------------------- diff --git a/packages/ni.measurementlink.measurement.v2.proto/docs/index.rst b/packages/ni.measurementlink.measurement.v2.proto/docs/index.rst index 4f8247c0..76840665 100644 --- a/packages/ni.measurementlink.measurement.v2.proto/docs/index.rst +++ b/packages/ni.measurementlink.measurement.v2.proto/docs/index.rst @@ -1,8 +1,21 @@ -######################################### -Protobuf types for NI discovery gRPC APIs -######################################### +############################################## +Protobuf Types for NI Measurement V2 gRPC APIs +############################################## + +.. include:: intro.inc + +Table of Contents +================= .. toctree:: - :maxdepth: 1 - :caption: Contents: + :maxdepth: 4 + + autoapi/index + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/packages/ni.measurementlink.measurement.v2.proto/docs/namespace.rst b/packages/ni.measurementlink.measurement.v2.proto/docs/namespace.rst new file mode 100644 index 00000000..75c031e8 --- /dev/null +++ b/packages/ni.measurementlink.measurement.v2.proto/docs/namespace.rst @@ -0,0 +1,19 @@ +ni.measurementlink.measurement.v2 +================================= + +.. py:module:: ni.measurementlink.measurement.v2 + +.. autoapi-nested-parse:: + + Package for ni.measurementlink.measurement.v2. + + + +Submodules +---------- + +.. toctree:: + :maxdepth: 1 + + /autoapi/ni/measurementlink/measurement/v2/measurement_service_pb2/index + /autoapi/ni/measurementlink/measurement/v2/measurement_service_pb2_grpc/index \ No newline at end of file diff --git a/packages/ni.measurementlink.measurement.v2.proto/docs/templates/autoapi/index.rst b/packages/ni.measurementlink.measurement.v2.proto/docs/templates/autoapi/index.rst new file mode 100644 index 00000000..458feb09 --- /dev/null +++ b/packages/ni.measurementlink.measurement.v2.proto/docs/templates/autoapi/index.rst @@ -0,0 +1,13 @@ +API Reference +============= + +This page contains auto-generated API reference documentation. + +.. + Custom index: reference https://github.com/readthedocs/sphinx-autoapi/issues/298 + Add the deepest implicit namespace package to the toctree. + +.. toctree:: + :titlesonly: + + /namespace \ No newline at end of file diff --git a/packages/ni.measurementlink.pinmap.v1.proto/docs/conf.py b/packages/ni.measurementlink.pinmap.v1.proto/docs/conf.py index 4e07e94d..7d05947f 100644 --- a/packages/ni.measurementlink.pinmap.v1.proto/docs/conf.py +++ b/packages/ni.measurementlink.pinmap.v1.proto/docs/conf.py @@ -10,12 +10,12 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - # "autoapi.extension", - # "m2r2", - # "sphinx.ext.autodoc", - # "sphinx.ext.intersphinx", - # "sphinx.ext.napoleon", - # "sphinx.ext.viewcode", + "autoapi.extension", + "m2r2", + "sphinx.ext.autodoc", + "sphinx.ext.intersphinx", + "sphinx.ext.napoleon", + "sphinx.ext.viewcode", ] root_path = pathlib.Path(__file__).parent.parent @@ -45,16 +45,13 @@ # tell autoapi to doc the public options autoapi_options = list(autoapi.extension._DEFAULT_OPTIONS) autoapi_options.remove("private-members") # note: remove this to include "_" members in docs -# autoapi_dirs = [root_path / "src" / "ni"] +autoapi_dirs = [root_path / "src" / "ni"] autoapi_python_use_implicit_namespaces = True autoapi_template_dir = "templates/autoapi" autoapi_python_class_content = "both" autoapi_type = "python" autodoc_typehints = "description" autoapi_file_patterns = ["*.pyi", "*.py"] -autoapi_ignore = [ - '**/__init__.py', -] def process_docstring(app, what, name, obj, options, lines): @@ -65,17 +62,19 @@ def process_docstring(app, what, name, obj, options, lines): def setup(sphinx): """Sphinx setup callback.""" - # sphinx.connect("autodoc-process-docstring", process_docstring) + sphinx.connect("autodoc-process-docstring", process_docstring) # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This patterns also effect to html_static_path and html_extra_path -exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "__init__.py"] +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] -# intersphinx_mapping = { - # "python": ("https://docs.python.org/3", None), -# } +intersphinx_mapping = { + "python": ("https://docs.python.org/3", None), + "protobuf": ("https://googleapis.dev/python/protobuf/latest/", None), + "grpc": ("https://grpc.github.io/grpc/python/", None), +} # -- Options for HTML output ---------------------------------------------- diff --git a/packages/ni.measurementlink.pinmap.v1.proto/docs/index.rst b/packages/ni.measurementlink.pinmap.v1.proto/docs/index.rst index dad715de..8667a1b7 100644 --- a/packages/ni.measurementlink.pinmap.v1.proto/docs/index.rst +++ b/packages/ni.measurementlink.pinmap.v1.proto/docs/index.rst @@ -2,7 +2,19 @@ Protobuf types for NI Pin Map gRPC APIs ################################################## +.. include:: intro.inc + +Table of Contents +================= + .. toctree:: - :maxdepth: 1 - :caption: Contents: + :maxdepth: 4 + + autoapi/index + +Indices and tables +================== +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/packages/ni.measurementlink.pinmap.v1.proto/docs/namespace.rst b/packages/ni.measurementlink.pinmap.v1.proto/docs/namespace.rst new file mode 100644 index 00000000..40f6d1a1 --- /dev/null +++ b/packages/ni.measurementlink.pinmap.v1.proto/docs/namespace.rst @@ -0,0 +1,19 @@ +ni.measurementlink.pinmap.v1 +============================ + +.. py:module:: ni.measurementlink.pinmap.v1 + +.. autoapi-nested-parse:: + + Package for ni.measurementlink.pinmap.v1. + + + +Submodules +---------- + +.. toctree:: + :maxdepth: 1 + + /autoapi/ni/measurementlink/pinmap/v1/pin_map_service_pb2/index + /autoapi/ni/measurementlink/pinmap/v1/pin_map_service_pb2_grpc/index \ No newline at end of file diff --git a/packages/ni.measurementlink.pinmap.v1.proto/docs/templates/autoapi/index.rst b/packages/ni.measurementlink.pinmap.v1.proto/docs/templates/autoapi/index.rst new file mode 100644 index 00000000..458feb09 --- /dev/null +++ b/packages/ni.measurementlink.pinmap.v1.proto/docs/templates/autoapi/index.rst @@ -0,0 +1,13 @@ +API Reference +============= + +This page contains auto-generated API reference documentation. + +.. + Custom index: reference https://github.com/readthedocs/sphinx-autoapi/issues/298 + Add the deepest implicit namespace package to the toctree. + +.. toctree:: + :titlesonly: + + /namespace \ No newline at end of file diff --git a/packages/ni.measurementlink.pinmap.v1.proto/src/ni/measurementlink/pinmap/v1/pin_map_service_pb2/__init__.pyi b/packages/ni.measurementlink.pinmap.v1.proto/src/ni/measurementlink/pinmap/v1/pin_map_service_pb2/__init__.pyi index 6a7ee8dc..c5e25b40 100644 --- a/packages/ni.measurementlink.pinmap.v1.proto/src/ni/measurementlink/pinmap/v1/pin_map_service_pb2/__init__.pyi +++ b/packages/ni.measurementlink.pinmap.v1.proto/src/ni/measurementlink/pinmap/v1/pin_map_service_pb2/__init__.pyi @@ -293,14 +293,17 @@ class QueryResourceAccessInformationRequest(google.protobuf.message.Message): """Required. The resource id of the registered pin map resource.""" instrument_type_id: builtins.str """Optional. The instrument type for which to get instrument resource access information. If unspecified, get instrument resource information for all instrument types connected in the registered pin map resource. + Pin maps have built in instrument definitions using the following NI driver based instrument type ids: - "niDCPower" - "niDigitalPattern" - "niScope" - "niDMM" - "niDAQmx" - "niFGen" - "niRelayDriver" + + - "niDCPower" + - "niDigitalPattern" + - "niScope" + - "niDMM" + - "niDAQmx" + - "niFGen" + - "niRelayDriver" + For custom instruments the user defined instrument type id is defined in the pin map file. """ @property @@ -387,14 +390,17 @@ class ResourceAccessInformation(google.protobuf.message.Message): """ instrument_type_id: builtins.str """The instrument type of the instrument resource. + Pin maps have built in instrument definitions using the following NI driver based instrument type ids: - "niDCPower" - "niDigitalPattern" - "niScope" - "niDMM" - "niDAQmx" - "niFGen" - "niRelayDriver" + + - "niDCPower" + - "niDigitalPattern" + - "niScope" + - "niDMM" + - "niDAQmx" + - "niFGen" + - "niRelayDriver" + For custom instruments the user defined instrument type id is defined in the pin map file. """ @property diff --git a/packages/ni.measurementlink.proto/docs/conf.py b/packages/ni.measurementlink.proto/docs/conf.py index f09566d4..3019960e 100644 --- a/packages/ni.measurementlink.proto/docs/conf.py +++ b/packages/ni.measurementlink.proto/docs/conf.py @@ -10,6 +10,7 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ + "autoapi.extension", "m2r2", "sphinx.ext.autodoc", "sphinx.ext.intersphinx", @@ -44,18 +45,13 @@ # tell autoapi to doc the public options autoapi_options = list(autoapi.extension._DEFAULT_OPTIONS) autoapi_options.remove("private-members") # note: remove this to include "_" members in docs -# Restore this to start building docs for source again -# AB#3233030 -# autoapi_dirs = [root_path / "src" / "ni"] +autoapi_dirs = [root_path / "src" / "ni"] autoapi_python_use_implicit_namespaces = True autoapi_template_dir = "templates/autoapi" autoapi_python_class_content = "both" autoapi_type = "python" autodoc_typehints = "description" autoapi_file_patterns = ["*.pyi", "*.py"] -autoapi_ignore = [ - '**/__init__.py', -] def process_docstring(app, what, name, obj, options, lines): @@ -72,10 +68,11 @@ def setup(sphinx): # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This patterns also effect to html_static_path and html_extra_path -exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "__init__.py"] +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] intersphinx_mapping = { "python": ("https://docs.python.org/3", None), + "protobuf": ("https://googleapis.dev/python/protobuf/latest/", None), } diff --git a/packages/ni.measurementlink.proto/docs/index.rst b/packages/ni.measurementlink.proto/docs/index.rst index bc037186..e6844614 100644 --- a/packages/ni.measurementlink.proto/docs/index.rst +++ b/packages/ni.measurementlink.proto/docs/index.rst @@ -2,7 +2,21 @@ Protobuf types for NI gRPC APIs ############################### +.. include:: intro.inc + +Table of Contents +================= + .. toctree:: - :maxdepth: 1 - :caption: Contents: + :maxdepth: 4 + + autoapi/index + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + diff --git a/packages/ni.measurementlink.proto/docs/namespace.rst b/packages/ni.measurementlink.proto/docs/namespace.rst new file mode 100644 index 00000000..9c7d3bfe --- /dev/null +++ b/packages/ni.measurementlink.proto/docs/namespace.rst @@ -0,0 +1,18 @@ +ni.measurementlink +================== + +.. py:module:: ni.measurementlink + +.. autoapi-nested-parse:: + + Package for ni.measurementlink. + + + +Submodules +---------- + +.. toctree:: + :maxdepth: 1 + + /autoapi/ni/measurementlink/pin_map_context_pb2/index diff --git a/packages/ni.measurementlink.proto/docs/templates/autoapi/index.rst b/packages/ni.measurementlink.proto/docs/templates/autoapi/index.rst new file mode 100644 index 00000000..458feb09 --- /dev/null +++ b/packages/ni.measurementlink.proto/docs/templates/autoapi/index.rst @@ -0,0 +1,13 @@ +API Reference +============= + +This page contains auto-generated API reference documentation. + +.. + Custom index: reference https://github.com/readthedocs/sphinx-autoapi/issues/298 + Add the deepest implicit namespace package to the toctree. + +.. toctree:: + :titlesonly: + + /namespace \ No newline at end of file diff --git a/packages/ni.measurementlink.sessionmanagement.v1.proto/docs/conf.py b/packages/ni.measurementlink.sessionmanagement.v1.proto/docs/conf.py index 4e07e94d..4a9e79c2 100644 --- a/packages/ni.measurementlink.sessionmanagement.v1.proto/docs/conf.py +++ b/packages/ni.measurementlink.sessionmanagement.v1.proto/docs/conf.py @@ -10,12 +10,12 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - # "autoapi.extension", - # "m2r2", - # "sphinx.ext.autodoc", - # "sphinx.ext.intersphinx", - # "sphinx.ext.napoleon", - # "sphinx.ext.viewcode", + "autoapi.extension", + "m2r2", + "sphinx.ext.autodoc", + "sphinx.ext.intersphinx", + "sphinx.ext.napoleon", + "sphinx.ext.viewcode", ] root_path = pathlib.Path(__file__).parent.parent @@ -45,16 +45,13 @@ # tell autoapi to doc the public options autoapi_options = list(autoapi.extension._DEFAULT_OPTIONS) autoapi_options.remove("private-members") # note: remove this to include "_" members in docs -# autoapi_dirs = [root_path / "src" / "ni"] +autoapi_dirs = [root_path / "src" / "ni"] autoapi_python_use_implicit_namespaces = True autoapi_template_dir = "templates/autoapi" autoapi_python_class_content = "both" autoapi_type = "python" autodoc_typehints = "description" autoapi_file_patterns = ["*.pyi", "*.py"] -autoapi_ignore = [ - '**/__init__.py', -] def process_docstring(app, what, name, obj, options, lines): @@ -65,7 +62,7 @@ def process_docstring(app, what, name, obj, options, lines): def setup(sphinx): """Sphinx setup callback.""" - # sphinx.connect("autodoc-process-docstring", process_docstring) + sphinx.connect("autodoc-process-docstring", process_docstring) # List of patterns, relative to source directory, that match files and @@ -73,9 +70,11 @@ def setup(sphinx): # This patterns also effect to html_static_path and html_extra_path exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "__init__.py"] -# intersphinx_mapping = { - # "python": ("https://docs.python.org/3", None), -# } +intersphinx_mapping = { + "python": ("https://docs.python.org/3", None), + "protobuf": ("https://googleapis.dev/python/protobuf/latest/", None), + "grpc": ("https://grpc.github.io/grpc/python/", None), +} # -- Options for HTML output ---------------------------------------------- diff --git a/packages/ni.measurementlink.sessionmanagement.v1.proto/docs/index.rst b/packages/ni.measurementlink.sessionmanagement.v1.proto/docs/index.rst index 9274fd86..3b935d59 100644 --- a/packages/ni.measurementlink.sessionmanagement.v1.proto/docs/index.rst +++ b/packages/ni.measurementlink.sessionmanagement.v1.proto/docs/index.rst @@ -2,7 +2,20 @@ Protobuf types for NI Session Management gRPC APIs ################################################## +.. include:: intro.inc + +Table of Contents +================= + .. toctree:: - :maxdepth: 1 - :caption: Contents: + :maxdepth: 4 + + autoapi/index + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/packages/ni.measurementlink.sessionmanagement.v1.proto/docs/namespace.rst b/packages/ni.measurementlink.sessionmanagement.v1.proto/docs/namespace.rst new file mode 100644 index 00000000..43006f4a --- /dev/null +++ b/packages/ni.measurementlink.sessionmanagement.v1.proto/docs/namespace.rst @@ -0,0 +1,19 @@ +ni.measurementlink.sessionmanagement.v1 +======================================= + +.. py:module:: ni.measurementlink.sessionmanagement.v1 + +.. autoapi-nested-parse:: + + Package for ni.measurementlink.sessionmanagement.v1. + + + +Submodules +---------- + +.. toctree:: + :maxdepth: 1 + + /autoapi/ni/measurementlink/sessionmanagement/v1/session_management_service_pb2/index + /autoapi/ni/measurementlink/sessionmanagement/v1/session_management_service_pb2_grpc/index \ No newline at end of file diff --git a/packages/ni.measurementlink.sessionmanagement.v1.proto/docs/templates/autoapi/index.rst b/packages/ni.measurementlink.sessionmanagement.v1.proto/docs/templates/autoapi/index.rst new file mode 100644 index 00000000..458feb09 --- /dev/null +++ b/packages/ni.measurementlink.sessionmanagement.v1.proto/docs/templates/autoapi/index.rst @@ -0,0 +1,13 @@ +API Reference +============= + +This page contains auto-generated API reference documentation. + +.. + Custom index: reference https://github.com/readthedocs/sphinx-autoapi/issues/298 + Add the deepest implicit namespace package to the toctree. + +.. toctree:: + :titlesonly: + + /namespace \ No newline at end of file diff --git a/packages/ni.protobuf.types/docs/conf.py b/packages/ni.protobuf.types/docs/conf.py index 4560b458..16b6e6f1 100644 --- a/packages/ni.protobuf.types/docs/conf.py +++ b/packages/ni.protobuf.types/docs/conf.py @@ -90,6 +90,7 @@ def setup(sphinx): "nitypes": ("https://nitypes.readthedocs.io/en/latest/", None), "numpy": ("https://numpy.org/doc/stable/", None), "python": ("https://docs.python.org/3", None), + "protobuf": ("https://googleapis.dev/python/protobuf/latest/", None), } diff --git a/third_party/ni-apis b/third_party/ni-apis index d4cf46e5..e5178ec4 160000 --- a/third_party/ni-apis +++ b/third_party/ni-apis @@ -1 +1 @@ -Subproject commit d4cf46e548e7ec35f69163e877d8c696c9bfcf1f +Subproject commit e5178ec44d96210e91e068ffb48543f3b9472b2d