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.
This PR adds a package
rstcheck
which validates syntax and formatting of.rst
based Sphinx documentation. The advantage of adding this package is that it can report simple errors in docs formatting without needing to build the documentation, either locally or in the pipeline. Therstcheck
tool is added both as a pre-commit hook as well as a pipeline step in thedocs
pipeline.To run the
rstcheck
tool locally you can use the following command from the root of thehermes_core
repository.closes #96