Fix rst issues identified by "sphinx-lint" #1652
Merged
Conversation
This file contains 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
modified: .github/workflows/test-documentation-build.yml
This comment was marked as outdated.
This comment was marked as outdated.
modified: docs/source/changelog.rst modified: docs/source/traits_user_manual/advanced.rst modified: docs/source/traits_user_manual/debugging.rst
This reverts commit b214682.
mdickinson
reviewed
Jun 13, 2022
| .. include:: ../../CHANGES.rst |
There was a problem hiding this comment.
Note to self: It's not clear from the GitHub diff, but this change is adding a missing trailing newline.
mdickinson
pushed a commit
that referenced
this pull request
Aug 9, 2022
* DEV: Install and run sphinx-lint in docs build CI job modified: .github/workflows/test-documentation-build.yml * FIX: Fix rst issues discovered by the linter modified: docs/source/changelog.rst modified: docs/source/traits_user_manual/advanced.rst modified: docs/source/traits_user_manual/debugging.rst * Revert "DEV: Install and run sphinx-lint in docs build CI job" This reverts commit b214682. (cherry picked from commit e525c57)
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.
Fix rst issues found by the
sphinx-lintlinter. Ref https://github.com/sphinx-contrib/sphinx-lintChecklist
TestsUpdate API reference (docs/source/traits_api_reference)Update User manual (docs/source/traits_user_manual)Update type annotation hints intraits-stubs