Skip to content

Enable documentation build extensions - #12

Open
namurphy wants to merge 13 commits into
PlasmaPy:mainfrom
namurphy:sphinx-extensions
Open

Enable documentation build extensions#12
namurphy wants to merge 13 commits into
PlasmaPy:mainfrom
namurphy:sphinx-extensions

Conversation

@namurphy

@namurphy namurphy commented Sep 2, 2026

Copy link
Copy Markdown
Member

Description

This pull request enables a few extensions for use in documentation builds.

Built-in extensions

  • sphinx.ext.apidoc — generate API docs
  • sphinx.ext.autodoc — include documentation from docstrings
  • sphinx.ext.duration — show durations in documentation builds
  • sphinx.ext.intersphinx — link to other projects' documentation
  • sphinx.ext.mathjax — render math with MathJax
  • sphinx.ext.napoleon — support numpy and google style docstrings
  • sphinx.ext.viewcode — add links to highlighted source code

Third-party extensions

Motivation

Much important functionality in Sphinx is not enabled by default, so it is necessary to enable them specifically. For example, sphinx.ext.autodoc is what gets used to put documentation for individual functions and classes in the documentation for the project.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant