Extensions

categories:

reference

We use a curated set of Sphinx extensions to enhance our documentation.

Core Extensions

• sphinx.ext.autodoc: Include documentation from docstrings.

• sphinx.ext.viewcode: Add links to highlighted source code.

• sphinx.ext.graphviz: Add Graphviz graphs.

• sphinx.ext.mathjax: Render math via JavaScript.

Community Extensions

• myst-parser: Use Markdown in Sphinx.

• sphinx-revealjs: Create presentations with Reveal.js.

• sphinx-carousel: Create carousels.

• sphinx-copybutton: Add a copy button to code blocks.

• sphinx-design: Add responsive web components.

Custom Extensions

• photon_platform.publish.directives.collection: A custom directive for aggregating content.