Sphinx Documentation Generation Integration #30
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
added 7 commits
January 5, 2022 12:18
…era-sds-pge package
…st, originally provided by Drew Meyers
…ally provided by Drew Meyers
…hinx documentation These files represent a modified subset of the Sphinx config files provided by Drew Meyers
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.
This PR modifies work graciously contributed by @drewmee to integrate Sphinx documentation generation into the opera-sds-pge repo. This version is essentially paired down from #26 to include only Sphinx-related capabilities, and tailor some of the .rst files to be apporpriate for OPERA. Integration of other capabilities, such as tox and integration with readthedocs will be tackled in later sprints.
Thanks again to @drewmee for taking the initiative on this, your contributions are greatly appreciated.
Resolves #12
Resolves #20