Documentation: Replace Sphinx Build with Jupyter Book #400
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
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.
Documentation: Update documentation site to Jupyter Book
This PR addresses the previously discussed process to convert the HOPP documentation to a Jupyter Book-powered site with the Jupyter Book theme. In addition to converting the build steps, much of the infrastructure has been simplified to reduce the highly nested API layout (mimicked
hopp/) to one that is easier to maintain over a longer period of time.Related issue
Resolves #399
Impacted areas of the software
docs/: New top-level files for the jupyter book specification anddocs/api/: The API folder replaces the older structure that mimics the hopp/ layout to simplify the documentation layout. Essentially there were many files dedicated to using autodoc to build a page for single (or two) classes that did not make much sense from an end product standpoint.readthedocs.yaml: Converts to the jupyter book build steps.github/workflows/: Two new workflows have been added: one for testing the documentation build on PRs, and another for publishing the documentation site to GitHub PagesAdditional supporting information
I have pinned additionally pinned Shapely at >= 2 since our use of their API changed in a previous release without pinning HOPP's minimum allowed version causing some autodoc build errors for me.
Test results, if applicable
N/A.