Skip to content

Commit 2aeb5e1

Browse files
authored
[releases/2.3] docs: Cherry-pick various doc updates (#1186)
* docs: Upgrade Sphinx and change copyright year to "2022-%Y" (#1118) * service: Reformat pyproject.toml * service: Upgrade to latest Sphinx * service: Update poetry.lock * service: Update copyright to reflect year first published * service: Add a comment about Sphinx version * docs: Add gRPC and protobuf hyperlinks * service: Update poetry.lock (cherry picked from commit 64174c6) * docs: Remove Sphinx --keep-going option (#1126) (cherry picked from commit 262ab18) * docs: Remove tomlkit dependency (#1166) * docs: Remove tomlkit dependency * service: Update poetry.lock (cherry picked from commit 15b1bb8)
1 parent b3e450c commit 2aeb5e1

File tree

6 files changed

+72
-2471
lines changed

6 files changed

+72
-2471
lines changed

.github/workflows/check_nims.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ jobs:
7676
run: |
7777
rm -rf docs
7878
mkdir -p docs
79-
poetry run sphinx-build _docs_source docs -b html -W --keep-going
79+
poetry run sphinx-build _docs_source docs -b html -W
8080
- name: Revert docs
8181
run: rm -rf docs
8282
- name: Generate gRPC stubs

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ The `ni_measurement_plugin_sdk_service` package uses Sphinx to build API
166166
reference documentation.
167167

168168
```cmd
169-
poetry run sphinx-build _docs_source docs -b html -W --keep-going
169+
poetry run sphinx-build _docs_source docs -b html -W
170170
```
171171

172172
The generated documentation is at `docs/index.html`.

packages/service/_docs_source/conf.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
"""Sphinx Configuration File."""
22

3-
import datetime
43
import pathlib
54

65
import autoapi.extension
@@ -27,8 +26,7 @@
2726

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

3331

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

8987

9088
intersphinx_mapping = {
89+
"grpc": ("https://grpc.github.io/grpc/python/", None),
9190
"nidaqmx": ("https://nidaqmx-python.readthedocs.io/en/stable/", None),
9291
"nidcpower": ("https://nidcpower.readthedocs.io/en/stable/", None),
9392
"nidigital": ("https://nidigital.readthedocs.io/en/stable/", None),
9493
"nidmm": ("https://nidmm.readthedocs.io/en/stable/", None),
9594
"nifgen": ("https://nifgen.readthedocs.io/en/stable/", None),
9695
"niscope": ("https://niscope.readthedocs.io/en/stable/", None),
9796
"niswitch": ("https://niswitch.readthedocs.io/en/stable/", None),
97+
"protobuf": ("https://googleapis.dev/python/protobuf/latest/", None),
9898
"python": ("https://docs.python.org/3", None),
9999
}
100100

packages/service/poetry.lock

Lines changed: 29 additions & 68 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)