Repository navigation
cleaned up documentation - #628
Open
aaronleesander wants to merge 31 commits into
Open
aaronleesander wants to merge 31 commits into
aaronleesander wants to merge 31 commits into
Conversation
aaronleesander
added
the
documentation
This branch has not been deployed
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 PR includes a full run through of the ReadtheDocs in order to make sure it is up to date with the major use cases of the package. It also speeds up the docs build significantly and adds tests to make sure that the plots generated remain correct with changes to the package.
In order to speed up docs and stay under RtD's 15min time limit, the examples now run in the CI. Another option was to use static figures that are saved in the library, but this allows them to be a type of test so we can see if any changes in a PR cause the docs to break.
Docstrings were also updated so that references within the docs are correct which leads to the large number of files being updated in this PR.
Codex assisted with this update.