docs: add reference check while build docs #1600
Merged
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.
Add cross-reference checker for sphinx.
with this PR, several options have been offered to make docstring more robust:
make html
will show warnings if the internal referenced link is incorrect.make linkcheck
same as above, without generating html pages.make coverage
check the docstring coverage.Some basic statistics:
broken links: Found 2724 broken links, ~2550 were broken links in CHANGELOG.md.
coverage: ~40 undocumented methods & classes.
warnings: 2721 warnings, mostly are class or method reference not found.