docs: Upgrade Sphinx and change copyright year to "2022-%Y" #1118
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bkeryan
requested review from
csjall,
dixonjoel,
mshafer-NI and
nstokes-nati
as code owners
Contributor
Collaborator
|
What happened to the checks on this PR? I'm waiting until we get a passing PR to review. |
Collaborator
Author
I think GitHub was having some problems on Friday. I saw checks hanging in other repos too. |
Collaborator
Author
|
Closing and reopening to try to fix GitHub checks |
bkeryan
force-pushed
the
users/bkeryan/upgrade-sphinx
branch
from
61a8575 to
5518f74
Compare
Collaborator
Author
The checks are passing now (despite Poetry+virtualenv |
dixonjoel
approved these changes
May 8, 2025
bkeryan
added a commit
that referenced
this pull request
Jun 23, 2025
* 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)
bkeryan
added a commit
that referenced
this pull request
Jun 24, 2025
* 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)
bkeryan
added a commit
that referenced
this pull request
Jun 25, 2025
* 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)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this Pull Request accomplish?
Upgrade to the latest Sphinx, which requires Python 3.11 or later.
Change copyright year to "2022-2025" to reflect the first year when this package and its documentation were published.
Use
%Yplaceholder to specify the year.Note
The package name was
ni-measurement-servicein 2022, then it was renamed toni-measurementlink-servicein 2023, and renamed again toni-measurement-plugin-sdk-servicein 2024.Reformat
pyproject.tomlbecause I have my editor configured to reformat now.Why should this Pull Request be merged?
While setting up Sphinx for another project, I noticed that the Python 3.9 version constraint requires using a Sphinx version from 2023 and the
%Yplaceholder was not supported with that older version.What testing has been done?
Ran
poetry run sphinx-build _docs_source docs -b html -W --keep-goingand inspected the output locally.It printed some warnings about ReadTheDocs's SSL certificates, so I'll check whether the PR build has the same warnings.