Enable documentation build extensions - #12
Open
namurphy wants to merge 13 commits into
Open
Conversation
This comes from PlasmaPy
I put the error in to make sure that doctests were being run.
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
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.
Description
This pull request enables a few extensions for use in documentation builds.
Built-in extensions
sphinx.ext.apidoc— generate API docssphinx.ext.autodoc— include documentation from docstringssphinx.ext.duration— show durations in documentation buildssphinx.ext.intersphinx— link to other projects' documentationsphinx.ext.mathjax— render math with MathJaxsphinx.ext.napoleon— support numpy and google style docstringssphinx.ext.viewcode— add links to highlighted source codeThird-party extensions
notfound.extension— adds a notfound pagesphinx_copybutton— adds a button that enables code to be copiedMotivation
Much important functionality in Sphinx is not enabled by default, so it is necessary to enable them specifically. For example,
sphinx.ext.autodocis what gets used to put documentation for individual functions and classes in the documentation for the project.