Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/check_nims.yml
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ jobs:
run: |
rm -rf docs
mkdir -p docs
poetry run sphinx-build _docs_source docs -b html -W --keep-going
poetry run sphinx-build _docs_source docs -b html -W
- name: Revert docs
run: rm -rf docs
- name: Generate gRPC stubs
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ The `ni_measurement_plugin_sdk_service` package uses Sphinx to build API
reference documentation.

```cmd
poetry run sphinx-build _docs_source docs -b html -W --keep-going
poetry run sphinx-build _docs_source docs -b html -W
```

The generated documentation is at `docs/index.html`.
Expand Down
6 changes: 3 additions & 3 deletions packages/service/_docs_source/conf.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
"""Sphinx Configuration File."""

import datetime
import pathlib

import autoapi.extension
Expand All @@ -27,8 +26,7 @@

project = proj_config["tool"]["poetry"]["name"]
company = "National Instruments"
year = str(datetime.datetime.now().year)
copyright = f"{year}, {company}"
copyright = f"2022-%Y, {company}"


# The version info for the project you're documenting, acts as replacement for
Expand Down Expand Up @@ -88,13 +86,15 @@ def setup(sphinx):


intersphinx_mapping = {
"grpc": ("https://grpc.github.io/grpc/python/", None),
"nidaqmx": ("https://nidaqmx-python.readthedocs.io/en/stable/", None),
"nidcpower": ("https://nidcpower.readthedocs.io/en/stable/", None),
"nidigital": ("https://nidigital.readthedocs.io/en/stable/", None),
"nidmm": ("https://nidmm.readthedocs.io/en/stable/", None),
"nifgen": ("https://nifgen.readthedocs.io/en/stable/", None),
"niscope": ("https://niscope.readthedocs.io/en/stable/", None),
"niswitch": ("https://niswitch.readthedocs.io/en/stable/", None),
"protobuf": ("https://googleapis.dev/python/protobuf/latest/", None),
"python": ("https://docs.python.org/3", None),
}

Expand Down
97 changes: 29 additions & 68 deletions packages/service/poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading