Implement sphinx and readthedocs.org for documentation #347
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
Moves the SECURITY.md and CHANGELOG.md to the project root in preparation for building documentation with sphinx.
Adds the initial docs folder. - created using the sphinx-quickstart - theme in conf.py replaced with sphinx_rtd_theme
To ensure that documentation builds locally add sphinx-build to tox.ini
Adds successful building of documentation as a requirement for CI with GitHub actions. Reuqires that previous tests pass before attempting so that time is not wasted.
bebleo
force-pushed
the
346-implement-docs
branch
from
8a0269d to
2570f84
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Adds: