Subcategories
Packages
Docutils converts plaintext documentation in reStructuredText format into multiple output formats including HTML, XML, and LaTeX using a modular processing system.
Sphinx generates professional documentation from reStructuredText source files, producing HTML, PDF, EPUB, and other formats with automatic cross-references, code highlighting, and hierarchical navigation.
Griffe extracts the complete structure and signatures of Python programs to generate API documentation or detect breaking changes in your project's public API.
Install it if you need to programmatically inspect Python code structure, generate API docs, or enforce API stability in CI.
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.
Material for MkDocs is a professional theme and extension for MkDocs that transforms Markdown documentation into a responsive, searchable static site with minimal configuration.
Install it if you need to publish Markdown-based documentation as a professional static site without writing custom HTML or CSS.
MkDocs generates static HTML documentation sites from Markdown source files, configured via a single YAML file, with support for themes, plugins, and Markdown extensions.
Install it if you need to generate static documentation from Markdown with minimal configuration; skip it if you require cutting-edge feature development or need…
Automates publishing built documentation to GitHub Pages by managing the gh-pages branch, handling file synchronization, and optionally pushing changes to a remote repository.
Generates OpenAPI specification documents from Python code, supporting versions 2 and 3 of the OpenAPI standard with framework-agnostic design and built-in marshmallow integration.
Install it if you need OpenAPI specs for a Python web service and want to avoid manual YAML maintenance.
A Sphinx theme that renders documentation with a responsive, mobile-friendly design optimized for reading on both desktop and mobile devices.
Install it if you use Sphinx and want a responsive, polished appearance without building a theme from scratch.
Represents and manipulates IPv4, IPv6, MAC addresses and related network objects; supports CIDR notation, subnetting, set operations, IANA lookups, and DNS reverse generation.
Generates OpenAPI 3.0.3, 3.1, and 3.2 schemas automatically from Django REST framework APIs, with extensive customization options for real-world use cases.
Install it if you need OpenAPI schemas for a DRF API and want automation over manual maintenance.
Provides type hints for the docutils library, enabling static type checkers like mypy and pyright to validate code that uses docutils for document processing and parsing.
Generates API documentation for Python projects by parsing source code and docstrings, integrating with mkdocstrings to produce searchable, cross-referenced documentation.
Install it if you use mkdocstrings and want to document Python code automatically.
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.
An MkDocs plugin that automatically generates API documentation from source code docstrings, supporting multiple programming languages through pluggable handlers.
Install it if you use MkDocs and want to automate API documentation from source code; you'll also need to install a language handler for your target language.
A MkDocs plugin that automatically creates cross-page links to headings and anchors by reference name, without requiring you to know or specify the destination page path.
Embeds Mermaid diagrams (flowcharts, sequence diagrams, Gantt charts, and more) directly into Sphinx-generated documentation.
Install it if you are using Sphinx and want to include Mermaid diagrams without managing separate image files.
Parses Markdown text according to the CommonMark specification and renders it to HTML, JSON, or an abstract syntax tree using pure Python.
Install only if you are maintaining legacy code that already depends on it.
Watches Sphinx documentation source files for changes and automatically rebuilds the docs, then reloads open browser windows to show the updated output.
Svglib reads SVG files and converts them to ReportLab Drawing objects, which can then be rendered to PDF, bitmap, or other formats supported by ReportLab.
Converts HTML and CSS to PDF documents using Python, enabling developers with web skills to generate PDF templates without learning specialized PDF libraries.
However, the aging maintenance status (last release 537 days ago) warrants caution in production: verify that its rendering quality and feature set meet your specific…
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.
Provides a Sphinx domain for documenting HTTP APIs with structured markup and cross-referencing support.
However, verify that its feature set and syntax match your API documentation needs, and be aware that maintenance is aging—check whether active alternatives or…
A Sphinx extension that checks documentation for spelling errors using PyEnchant, producing a report of misspelled words found during documentation builds.
Install it if spelling validation is part of your documentation workflow.
Generates Swagger/OpenAPI 2.0 specifications automatically from Django REST Framework APIs, with built-in UI viewers for swagger-ui and ReDoc.
Furo is a clean, responsive Sphinx theme for generating HTML documentation with minimal visual scaffolding, customizable colors and fonts, and sidebar navigation optimized for smaller documentation sets.
Install it if you use Sphinx and want a cleaner, responsive theme with minimal setup.
Mdformat is a CommonMark-compliant command-line Markdown formatter and Python library that enforces consistent style across Markdown files.
Install it if you want a lightweight, pure-Python formatter; consider its plugin ecosystem if you need support for non-CommonMark dialects.
Provides a modern, minimal Sphinx theme skeleton for building custom documentation themes with contemporary web standards and structure.
However, be aware that maintenance is dormant—last commit 2023-10-11—so you should verify compatibility with your Sphinx version and be prepared to maintain…
Delivers embedded documentation for ComfyUI's core nodes, packaged as a Python module that integrates node help content directly into the ComfyUI application.
Extends MkDocs with Jinja2 templating to use variables and macros in markdown pages, enabling dynamic content generation and custom syntax extensions.
Install it if your MkDocs site requires variables, macros, or conditional rendering.
A Sphinx extension that parses and renders docstrings written in NumPy documentation format, adding specialized directives for function and code documentation.
ProperDocs is a static site generator that converts Markdown documentation into HTML, configured through a single YAML file and extensible with themes and plugins.
Install it if you need a straightforward static documentation generator; verify the plugin ecosystem and programmatic API match your workflow before committing to it…
pdoc generates API documentation for Python projects by parsing source code and docstrings into standalone HTML, with a built-in web server and live reloading.
Install it if you need quick, zero-configuration HTML documentation from Python docstrings and type hints.