Subcategories
Packages
A Sphinx extension that automatically runs sphinx-apidoc during documentation builds, generating API documentation from Python source code without requiring separate build steps.
However, check whether Sphinx's built-in apidoc extension meets your needs first, as the project documentation recommends new users adopt that instead and notes this…
A MkDocs plugin that scans Markdown files for TODO, NOTE, and PLACEHOLDER annotations and automatically generates an organized task list.
However, note that maintenance is aging (last release over a year ago), so consider whether you're comfortable with a package that may not receive rapid updates.
Builds and previews documentation for Hugging Face repositories, converting markdown and notebooks into MDX and HTML with support for multilingual docs and GitHub Actions integration.
Measures docstring coverage in Python source code by scanning for missing docstrings in functions, classes, methods, and modules, then reports statistics and identifies gaps.
However, maintenance is dormant (last release May 2024, no commits for 829 days), so verify compatibility with your Python version before relying on it for critical…
Generates OpenAPI v2 and v3 documentation in JSON and YAML formats, and converts OpenAPI files into MkDocs, Markdown, and PlantUML diagrams.
Provides PEP 561 type stubs for docutils, enabling type checking and IDE autocompletion when working with the docutils library.
Provides docutils helpers and utilities for Antsibull tools, extending docutils functionality for documentation processing within the Ansible ecosystem.
However, if you are not working within the Ansible ecosystem or using Antsibull, this library offers little direct value—it is a specialized utility for a specific…
A MkDocs plugin that embeds videos in documentation pages using Markdown image syntax with a configurable marker and HTML5 video or iframe output.
However, be aware the project is abandoned; install it only if you can tolerate no future updates and your MkDocs version and video needs are unlikely to change…
Runs linters, formatters, and other command-line tools against code blocks embedded in documentation files (reStructuredText, Markdown, MyST, MDX, Djot, Norg).
Install it if you maintain documentation with embedded code examples and want automated validation.
Extracts and serializes Python object documentation (modules, classes, functions, attributes) from source code, accepting JSON input describing what to document and outputting structured JSON with parsed docstrings and metadata.
Extends Griffe to recognize and render PEP 702 `@warnings.deprecated` markers in Python code documentation, surfacing deprecation notices during API analysis.
Loads Sphinx documentation configuration from pyproject.toml instead of keeping it all in conf.py, using PEP 621 project metadata and custom tool settings.
Inspect, search, and manipulate Sphinx objects.inv inventory files from the command line or Python API, enabling precise cross-reference discovery and inventory editing.
Install it if you write Sphinx documentation or manage documentation builds.
A MkDocs plugin that embeds interactive Drawio diagrams directly into documentation by converting .drawio image references into embedded diagram viewers.
Install it if your MkDocs project needs embedded Drawio diagrams; the dependency footprint is small and the setup is straightforward.
Provides a Pygments lexer and style for syntax-highlighting Ansible output, registered globally as `ansible-output` for use in any tool that integrates Pygments.
A modern, responsive Sphinx documentation theme based on VuePress that renders Sphinx projects with a contemporary design using Vue.js and Stylus.
However, install only if you can tolerate dormant maintenance: the 874-day gap since the last release and the author's public call for maintainers mean bug fixes and…
Renders Swagger and OpenAPI schemas as interactive documentation within MkDocs sites using Swagger UI, supporting both local JSON files and external URLs.
However, be aware that maintenance is dormant—if you encounter issues or need support for newer OpenAPI versions, you may need to fork or patch the plugin yourself.
Adds a Git-based revision date to MkDocs documentation pages, displaying when each page was last modified according to Git history in ISO format (YYYY-mm-dd).
Paver is a Python-based task automation and scripting tool for software projects, similar to Make or Rake, designed to automate repetitive development tasks using Python syntax.
Programmatically generate and validate Atlassian Document Format (ADF) documents for Confluence and Jira, with tree-like representation, JSON rendering, templating, and variable substitution.
Provides a collection of MkDocs plugins and Markdown extensions for generating API documentation from OpenAPI specs and rendering styled components like cards, timelines, Gantt diagrams, and enhanced tables.
MkDocs plugin that fetches and displays a list of contributors to each documentation page from GitHub or GitLab APIs, along with the last commit date.
A Sphinx extension that executes arbitrary shell commands and embeds their output directly into reStructuredText documentation, with options for syntax highlighting, text replacement, and prompt display.
However, the aging codebase (last release 2018) means you should verify compatibility with your Python version and Sphinx version before relying on it for critical docs.
A ProperDocs plugin that allows placing the properdocs.yml configuration file in the same directory as your documentation files, rather than requiring it to be in a separate parent directory.
citeproc-py processes Citation Style Language (CSL) stylesheets to generate formatted citations and bibliographies in plain text, reStructuredText, and HTML from structured reference data.
However, check the list of unimplemented CSL features (disambiguation, et-al rules, collapsing) against your requirements—if you need those features, you may hit…
Provides Sphinx themes styled for Pallets project documentation (Flask, Jinja, Werkzeug, Click), enabling consistent visual presentation across related projects.
Install only if you intend to use one of the four named themes; it adds no value for unrelated Sphinx projects.
Applies Black code formatting to Python code blocks embedded in documentation files (Markdown, reStructuredText, LaTeX) and Python docstrings.
Install it if you maintain documentation with embedded Python code and want to keep those examples formatted consistently with Black.
Automatically generates API reference documentation and navigation for Python modules using mkdocstrings, eliminating the need for manual navigation configuration or custom scripts.
A Sphinx extension that generates formatted changelog displays from reStructuredText markup, organizing changes by version, tags, and sections.
A Sphinx extension that renders mathematical equations in HTML documentation using KaTeX instead of MathJax, with optional server-side pre-rendering support.
However, note that the package is aging (413 days since last release) and optional server-side pre-rendering adds a nodejs dependency; verify compatibility with your…
Adds a cleaner block-level syntax to Markdown for creating highlighted admonition blocks (callouts) that degrade gracefully in vanilla renderers.
A Sphinx extension that renders reStructuredText documentation content from external data files (JSON, YAML, CSV) using templating, allowing you to keep data separate from documentation source.
However, the aging maintenance status (last release 2023-12-21, 967 days old) means you should verify compatibility with your Sphinx version and be prepared to…
Integrates ruff code formatting into mdformat to automatically format Python code blocks within Markdown files.
Injects mkdocs.yml extra variables into markdown files before rendering to HTML, allowing you to use template variables like {{ customer.name }} directly in your markdown content.
A plugin for mdformat that automatically formats Python code blocks in Markdown files using Black's code style rules.
However, the aging maintenance status (last release 2020-09-24) means you should verify compatibility with your current Black and mdformat versions before relying on…
pydoctor generates API documentation from Python source code through static analysis, supporting multiple docstring formats including epytext, reStructuredText, Google, and Numpy styles.
Generates changelogs automatically from git commit history using Jinja2 templates, with built-in support for multiple commit conventions and git hosting platforms.
A MkDocs plugin that fetches and embeds markdown content or specific sections from external URLs directly into your documentation pages using Jinja2 template syntax.
Mdformat-toc is an mdformat plugin that automatically generates and maintains a table of contents in Markdown files, with configurable heading levels and anchor generation.
A Sphinx extension that organizes changelog entries generated by versionadded, versionchanged, and deprecated directives into a collapsible, reverse-chronologically sorted log.