Packages
Parses Python docstrings in ReST, Google, Numpydoc, and Epydoc formats, extracting structured information like descriptions, parameters, return types, and exceptions.
Install it if you need to programmatically read and extract structured data from Python docstrings.
Sphinx generates professional documentation from reStructuredText source files, producing HTML, PDF, EPUB, and other formats with automatic cross-references, code highlighting, and hierarchical navigation.
A Sphinx extension that outputs documentation in serialized HTML formats (JSON and pickle) alongside standard HTML.
Alabaster is a clean, responsive Sphinx theme for documentation that requires Python 3.10 or newer and Sphinx 6.2 or newer.
A Sphinx extension that generates HTML help files from reStructuredText documentation source.
A Sphinx extension that converts documentation source files into QtHelp format, enabling integration with Qt-based help systems and documentation viewers.
However, be aware that maintenance is dormant—if you rely on it long-term, monitor Sphinx compatibility and consider whether QtHelp remains the right format for your…
Sphinx extension that generates Apple help books from reStructuredText documentation.
However, verify that Apple help format output remains compatible with your target macOS versions, and be aware that dormant maintenance means bug fixes or format…
A Sphinx extension that generates Devhelp documentation output format, allowing Sphinx-built documentation to be read in the Devhelp help viewer.
A Sphinx extension that renders mathematical display equations in HTML output using JavaScript.
A Sphinx extension that ensures jQuery is available for use by Sphinx themes and extensions, with optional subresource integrity (SRI) checks for loaded JavaScript files.
Automatically extracts Python type hints from your code and injects them into Sphinx-generated documentation, eliminating the need to duplicate type information in docstrings.
Install it if you use Sphinx and want your type hints to flow automatically into your documentation.
A Sphinx extension that adds a copy button to code blocks in documentation, allowing readers to quickly copy code snippets to their clipboard.
Python driver for ArangoDB that provides synchronous access to document, graph, and search operations across ArangoDB's multi-model database.
Install it if you are building against ArangoDB 3.11+ and need synchronous Python access to documents, graphs, or search.
Watches Sphinx documentation source files for changes and automatically rebuilds the docs, then reloads open browser windows to show the updated output.
A Bootstrap-based Sphinx theme that provides a clean, three-column layout for documentation sites built with Sphinx.
Sphinx extension that automatically generates documentation for argparse command-line interfaces by introspecting their argument definitions.
A Sphinx plugin that embeds interactive Swagger UI pages into documentation to render OpenAPI specifications with customizable configuration and optional local resource mirroring.
Install it if you use Sphinx and need to include OpenAPI specifications in your documentation.
Sphinx AutoAPI generates complete API documentation by parsing source code, without requiring imports or manual authoring—it integrates as a Sphinx extension to automatically create and organize API docs.
Install it if you use Sphinx and want automatic API documentation.
A Sphinx extension that lets you embed Jinja2 templates directly into reStructuredText documentation, generating dynamic content at build time.
However, because the last release was in 2022 and the repository has seen no commits since 2023-11-02, do not expect bug fixes or compatibility updates for future…
A Sphinx extension that adds tabbed content blocks to HTML documentation, supporting basic tabs, grouped tabs with synchronized selection, and syntax-highlighted code tabs.
nbsphinx is a Sphinx extension that parses Jupyter Notebook files (.ipynb) as documentation source, rendering notebook code cells and their outputs in Sphinx-generated HTML and LaTeX documentation, with automatic execution of unevaluated notebooks during the build.
Install it if you want to include executable notebooks or notebook-style examples in your Sphinx docs; skip it if your documentation doesn't use notebooks.
Converts written-out number words (like "twenty one") into numeric digits (21), supporting positive integers and decimals up to 999,999,999,999.
No—install only if you have a legacy codebase already using it.
Breathe is a Sphinx plugin that renders Doxygen-generated documentation into your Sphinx documentation build, letting you embed API reference material from C/C++ code directly into user-facing docs.
Install it if your documentation workflow already includes Doxygen; skip it if you're looking for pure Python API documentation.
Converts Python docstrings from reStructuredText and Google format to Markdown on the fly, with extensibility via entry points for custom converters.
Provides utilities to enhance Python's enum module with better Sphinx documentation, member docstrings via decorators, and custom enum classes with extended functionality.
Provides a Python API to integrate Sphinx-generated documentation into web applications, enabling server-side search and interactive documentation features.
However, the aging maintenance status (746 days since last release) means you should verify compatibility with your target Sphinx version and be prepared to handle…
Parses Python docstrings in ReST, Google, Numpydoc, and Epydoc formats, extracting structured metadata like parameters, return types, and exceptions.
Install it if you need programmatic access to docstring metadata; verify against the CHANGELOG.md that the fork's fixes and additions matter for your use case.
A Sphinx theme that renders documentation as an interactive book with Bootstrap 5 styling, flexible layouts inspired by Edward Tufte's design principles, and support for Jupyter Notebook cells and BinderHub integration.
However, be aware it is in maintenance mode—new features are unlikely, so evaluate whether its current capabilities meet your needs before adopting it.
Enables Sphinx and Docutils projects to parse and render CommonMark (Markdown) files alongside reStructuredText, bridging CommonMark syntax to the Docutils document model.
Sphinx Prompt is a Sphinx extension that renders shell and code prompts in documentation as unselectable, styled text blocks for multiple languages including bash, Python, PowerShell, and batch.
Install it if you document shell commands or code examples in Sphinx and want styled, user-friendly prompts.
Sphinx extension that generates HTML redirect pages with meta refresh tags when you rename or move documentation files, preventing 404 errors without server-side configuration.
A Sphinx extension that generates a custom 404 error page with absolute URLs hardcoded for documentation sites.
Sphinx Lint checks reStructuredText and Python documentation files for stylistic and formal issues that Sphinx itself may not catch, running as a command-line linter or pre-commit hook.
Sphinx-click is a Sphinx extension that automatically extracts and renders documentation from Click-based CLI applications directly into your Sphinx docs.
Install it if you want to automate CLI documentation; skip it if you don't use Click or Sphinx.
Sphinx extension that automatically generates Open Graph metadata tags for documentation pages, enabling proper preview rendering when documentation links are shared on social media.
Generates sitemaps.org-compliant XML sitemaps for Sphinx documentation, supporting multiple versions and languages in a single output.
Install it if you host Sphinx documentation and want search engines to reliably discover all versions or language variants of your docs.
Sphinx-toolbox extends Sphinx with a collection of utility extensions and helpers that simplify documentation generation and enhance the standard Sphinx workflow.
Install it if your documentation workflow would benefit from pre-integrated Sphinx utilities; skip it if you prefer to hand-pick individual extensions.
Patches Jinja2 v3 to restore compatibility with earlier Sphinx versions and fixes some Sphinx versions on Python 3.10.
Install only if you actually face the compatibility issues it addresses—it's a targeted fix, not a general dependency.
Sphinx-Gallery is a Sphinx extension that automatically generates HTML galleries of executable examples from Python scripts, extracting outputs and embedding them into your documentation.
Install it if you need to showcase runnable examples in Sphinx documentation.
A Sphinx extension that automatically extracts and displays the last-updated timestamp for each documentation page from Git commit history, checking dependencies and included files for more recent changes.