Skip to content

Conversation

@bkeryan
Copy link
Collaborator

@bkeryan bkeryan commented May 2, 2025

  • This contribution adheres to CONTRIBUTING.md.
  • I've updated CHANGELOG.md if applicable.
  • I've added tests applicable for this pull request

What does this Pull Request accomplish?

  • Convert the docs extra to a Poetry dependency group.
  • Upgrade to the latest Sphinx, which requires Python 3.11 or later.
  • Update GItHub workflow, ReadTheDocs config, and Tox config to use Python 3.11 for docs.
  • Enable the Intersphinx plugin in order to automatically hyperlink to Python and NumPy docs.
  • Update copyright range to "2017-%Y" to reflect the first year in which the nidaqmx package was published. Note that the %Y placeholder was added in a recent version of Sphinx.
  • My text editor reformatted pyproject.toml and conf.py.

Why should this Pull Request be merged?

Improve documentation and maintainability slightly.

What testing has been done?

Ran poetry run tox -e docs locally. I got SSL errors from Intersphinx but I think that's an issue with my machine and shouldn't affect the GitHub and ReadTheDocs build agents.

@bkeryan bkeryan requested review from maxxboehme and zhindes as code owners May 2, 2025 00:39
@github-actions
Copy link
Contributor

github-actions bot commented May 2, 2025

Test Results

    34 files  ±0      34 suites  ±0   57m 13s ⏱️ - 2m 13s
 2 396 tests ±0   2 042 ✅ ±0    354 💤 ±0  0 ❌ ±0 
43 102 runs  ±0  36 850 ✅ ±0  6 252 💤 ±0  0 ❌ ±0 

Results for commit 4c64456. ± Comparison against base commit db80440.

♻️ This comment has been updated with latest results.

@bkeryan
Copy link
Collaborator Author

bkeryan commented May 2, 2025

NumPy and Python hyperlinks are working: https://nidaqmx-python--710.org.readthedocs.build/en/710/stream_writers.html
image

@bkeryan bkeryan changed the title docs: Remove docs extra, upgrade Sphinx, enable hyperlinks to Python/NumPy docs docs: Remove docs extra, upgrade Sphinx, enable hyperlinks to gRPC/Python/NumPy docs May 2, 2025
@bkeryan
Copy link
Collaborator Author

bkeryan commented May 2, 2025

FYI @zhindes I also added hyperlinks to gRPC and Protobuf.

There's at least one link to gRPC here: https://nidaqmx-python--710.org.readthedocs.build/en/710/grpc_session_options.html#nidaqmx.GrpcSessionOptions

Not sure about protobuf but measurement-plugin-python had some links to it so I know the URL works.

@bkeryan bkeryan merged commit 6aa71c5 into master May 5, 2025
17 checks passed
@bkeryan bkeryan deleted the users/bkeryan/update-docs branch May 5, 2025 16:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants