Skip to content

Conversation

@bkeryan
Copy link
Collaborator

@bkeryan bkeryan commented Apr 29, 2025

What does this Pull Request accomplish?

Use the sphinx-autoapi plugin to generate API reference documentation. The configuration is based on https://github.com/ni/measurement-plugin-python/blob/main/packages/service/_docs_source/conf.py

Why should this Pull Request be merged?

Closes AB#3111356 - Enable doc generation with sphinx-autoapi

What testing has been done?

Ran poetry run sphinx-build docs docs/_build -b html -W --keep-going locally and examined docs\_build\index.html in a web browser.

@bkeryan bkeryan requested a review from csjall as a code owner April 29, 2025 23:19
@github-actions
Copy link
Contributor

github-actions bot commented Apr 29, 2025

Test Results

   10 files  ±  0     10 suites  ±0   26s ⏱️ +4s
  391 tests + 41    386 ✅ + 42   5 💤  -  1  0 ❌ ±0 
3 910 runs  +410  3 860 ✅ +420  50 💤  - 10  0 ❌ ±0 

Results for commit 00ca56c. ± Comparison against base commit 0d515bc.

♻️ This comment has been updated with latest results.

@bkeryan
Copy link
Collaborator Author

bkeryan commented Apr 29, 2025

The output is uploaded as a build artifact:
image

Once we have a ReadTheDocs site for this project, the output will be hosted on the RTD site and we won't need this build artifact.

@bkeryan bkeryan mentioned this pull request Apr 29, 2025
1 task
@bkeryan
Copy link
Collaborator Author

bkeryan commented Apr 30, 2025

FYI: The "Run CI / Check / Check nitypes" check is pending because I renamed it and the branch protection rules reference the old name. I will update the branch protection rules before merging this PR.

@bkeryan bkeryan merged commit 375f6da into main Apr 30, 2025
14 checks passed
@bkeryan bkeryan deleted the users/bkeryan/docs branch April 30, 2025 18:30
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.

4 participants