workflows: Check documentation in check_nims and fix Sphinx errors/warnings
#384
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 and
pbirkhol-ni
as code owners
Contributor
Both the "Attributes:" section and autoapi are generating documentation for NamedTuple fields, which leads to warnings like this: WARNING: duplicate object description of ni_measurementlink_service._internal.parameter.metadata.ParameterMetadata.display_name, other instance in autoapi/ni_measurementlink_service/_internal/parameter/metadata/index, use :noindex: for one of them
ERROR: Unexpected indentation. WARNING: Block quote ends without a blank line; unexpected unindent.
bkeryan
changed the title
check_nimscheck_nims and fix Sphinx errors/warnings
dixonjoel
reviewed
Sep 20, 2023
dixonjoel
reviewed
Sep 20, 2023
dixonjoel
reviewed
Sep 20, 2023
dixonjoel
approved these changes
Sep 20, 2023
1 task
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?
Update
check_nimsworkflow to generate API reference documentation and check for errors.Upgrade to latest documentation tools.
Fix or suppress all Sphinx errors and warnings.
Why should this Pull Request be merged?
Help developers avoid using invalid markup in docstrings.
What testing has been done?
None.