Fix Sphinx documentation build#279
Open
paco-barreras wants to merge 2 commits into
Open
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
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.
This fixes the docs build from the current main branch. The documentation now has an API reference target, no longer points at stale generated pages or build-output image paths, and the example notebooks used by the docs have been refreshed where they had drifted from the examples folder.
I also tightened the docs build environment so Read the Docs installs the package before autodoc runs, added Napoleon for the existing NumPy-style docstrings, and cleaned the small docstring issues that were surfacing as Sphinx warnings.
We don't have tests for this site yet, so @carolineychen8 or @pran-tae please verify locally with
python -m sphinx -b html -W -E docs docs\_build\html.