A curated list of awesome tools for Sphinx Python Documentation Generator

Overview

Awesome Sphinx (Python Documentation Generator)

A curated list of awesome extra libraries, software and resources for Sphinx (Python Documentation Generator). Inspired by awesome-sqlalchemy. (See also other awesome lists!)

Licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.

Your contributions are welcome.

Sphinx

Articles & Presentations

Documenting Your Project With Sphinx
Exercises for the Sphinx Tutorial that Brandon Rhodes often gives at PyCon.

Extensions

breathe
ReStructuredText and Sphinx bridge to Doxygen.
javasphinx
Sphinx extension for documenting Java projects.
numpydoc
NumPy's Sphinx extensions.
Releases
A Sphinx changelog-generating extension.
sphinx-autodoc-annotation
Use Python 3 annotations in sphinx-enabled docstrings.
sphinx-autodoc-typehints
Type hints support for the Sphinx autodoc extension
sphinx-fortran-extension
A Fortran domain and autodocumentation module for Sphinx.
sphinx-git
git Changelog for Sphinx.
sphinx-jekyll-builder
sphinx builder that outputs jekyll compatible markdown files with frontmatter
sphinx-markdown-builder
Sphinx builder that outputs markdown files.
Sphinx-prompt
Sphinx directive to add unselectable prompt.
Sphinx-pyreverse
Simple sphinx wrapper around pyreverse (from pylint suit) to generate UML diagramms from modules.
sphinxcontrib-autojs
The auto JavaScript documentation Sphinx extension.
sphinxcontrib-autoprogram
Provides an automated way to document CLI programs.
sphinxcontrib-blockdiag
Sphinx extension for embedding blockdiag diagrams.
sphinxcontrib-cldomain
Common Lisp domain for Sphinx.
sphinxcontrib-docbookrestapi
Sphinx extension that generates documentation for api-site from RST files.
sphinxcontrib-fulltoc
Extension for Sphinx to make the sidebar show a full table of contents instead of just the local headings.
sphinxcontrib-httpdomain
Provides a Sphinx domain for describing RESTful HTTP APIs. Also supports reflection for Flask, Bottle, and Tornado apps.
cornice.ext.sphinxext
Sphinx extension to build RESTful HTTP API documentation from Pyramid Cornice docstrings.
sphinxcontrib-programoutput
Sphinx extension to include program output into documents.
sphinxcontrib-napoleon
Napoleon is a pre-processor that parses NumPy and Google style docstrings.
Tut
Tut is a tool that helps you write tutorial style documentation using Sphinx.
Hieroglyph
Hieroglyph is an extension for Sphinx which builds HTML slides from ReStructuredText documents.
Sphinx-Needs
Sphinx-Needs allows the definition, linking, and filtering of need-objects: requirements, specifications, implementations, test cases, and more.
nbsphinx
Parse, execute, and generate output from Jupyter notebooks as HTML and LaTeX. Markdown in .ipynb is converted to RST with Pandoc. Markdown cells may contain toctree markup for generating tables of contents including .ipynb and .rst files.
Sphinxcontrib-proof
Sphinx extension to typeset definitions, theorems, proofs, etc.
Sphinxcontrib-packages
A sphinx extension to list tools installed on the machine generating the documentation (python versions, binaries, python packages, LaTeX packages, etc.). Useful to know which tools are installed on Readthedocs when writing your own extension.
sphinx-sitemap
sphinx-sitemap silently generates a sitemap for HTML builds.
sphinx-jsonschema
Turns a jsonschema into an integral part of your documentation. Useful when you want a single source for both validation and documentation of your JSON entities.
sphinx-gitstamp
Makes the git timestamp for each page available to HTML templates.

Internationalizations

sphinx-intl
Sphinx utility that make it easy to translate and to apply translation.

Miscellaneous

django-sphinxdoc
Integrate Sphinx documentation into a Django-powered website. Allows you to use your sites templates, auth and so on. Offers search via Haystack.
ome-documentation
Sphinx-based documentation for the Open Microscopy Environment.
riv.vim
ReStructured text editing extensions for Vim, GVim, MacVim; optionally with InstantRst gevent live reload.
sphinx-gui
Desktop GUI for editing Sphinx docs.
sphinx-markdown-sample
Markdown based sphinx the documentation generator sample.
tinkerer
Blog engine static HTML5 generator with categories, tags, landing page, nav sidebar, RSS powered by Sphinx and responsive Jinja templates.
ablog
ABlog is a Sphinx extension that converts any documentation or personal website project into a full-fledged blog with atom feeds, archive pages, blog sidebars, Disqus integration, Font-Awesome integration and easy GitHub Pages deploys

Themes

Alabaster
Modified Kr Sphinx doc theme.
flask-sphinx-themes
Sphinx Themes for Flask related projects and Flask itself.
krTheme Sphinx Style
Sphinx theme Kenneth Reitz uses for most projects e.g. Requests.
Sphinx Readable Theme
A clean and readable Sphinx theme with focus on autodoc โ€“ documentation from docstrings.
sphinx-better-theme
A theme for Sphinx that looks nice, is easy to style with CSS, works well on small screens and mobile devices, and organizes the page better.
sphinx_rtd_theme
Sphinx theme for readthedocs.io.
sphinx-theme-graphite
A slightly muted light-on-dark theme for the Sphinx document generator using only CSS.
sphinxjp.themes.basicstrap
Sphinx theme built with responsive Bootstrap.
sublee-sphinx-themes
Sphinx themes Heungsub Lee uses for his projects e.g. Energy, Korean, Ranking, TrueSkill.
sphinx-py3doc-enhanced-theme
A theme based on the theme of https://docs.python.org/3/ with some responsive enhancements.
sphinx-bootstrap-theme
Integrates Bootstrap CSS/Javascript framework responsive design with any Bootswatch CSS themes.
sphinx-foundation-theme
Theme based on the Foundation 4 CSS framework.
sphinx-nameko-theme
Forked from Sphinx Readable Theme, combined with elements of the Read The Docs theme.
sphinx-guzzle-theme
Sphinx theme used by Guzzle: http://guzzlephp.org
sphinx-hbp-theme
HumanBrainProject Collaboratory Sphinx Theme.
crate-docs-theme
This project provides a Sphinx theme for Crate's documentation that is compatible with ReadTheDocs.
solar-theme
Solar is an attempt to create a theme for the Python Sphinx documentation generator based on the Solarized color scheme.
sphinxtrap-theme
Sphinxtrap is a minimalist bootstrap2-based + fontawesome sphinx theme.
mdn-sphinx-theme
This is a version of the Mozilla Developer Network theme, for the Sphinx documentation engine.
sphinx_adc_theme
The Apple Developer Connection theme for sphinx

Publication

Read the Docs
Read the Docs hosts documentation, making it fully searchable and easy to find. You can import your docs using any major version control system, including Mercurial, Git, Subversion, and Bazaar. It supports webhooks so your docs get built when you commit code. There's also support for versioning so you can build docs from tags and branches of your code in your repository. A full list of features is available.
Okydoky
Automated docs builder using Sphinx/GitHub/Distribute for private use.
sphinx-autobuild
Watch a Sphinx directory and rebuild the documentation when a change is detected.
sphinx-server
A universal Sphinx Server based on sphinx-autobuild with Docker support that can be used in production (self-hosted) and for documentation development, bundled with PlantUML, Graphviz and HTTP authentication.
sphinx-me
Wraps your README-only projects in a dynamic Sphinx shell for hosting on Read the Docs.
Sphinx to GitHub
Script to prepare Sphinx html output for GitHub Pages.
ghp-import
Script to overwrite a gh-pages/master branch with a .nojekyll file for GitHub Pages.
Owner
Hyunjun Kim
Hyunjun Kim
A curated list of awesome mathematics resources

A curated list of awesome mathematics resources

Cyrille Rossant 6.7k Jan 05, 2023
Generate a single PDF file from MkDocs repository.

PDF Generate Plugin for MkDocs This plugin will generate a single PDF file from your MkDocs repository. This plugin is inspired by MkDocs PDF Export P

198 Jan 03, 2023
This is a repository for "100 days of code challenge" projects. You can reach all projects from beginner to professional which are written in Python.

100 Days of Code It's a challenge that aims to gain code practice and enhance programming knowledge. Day #1 Create a Band Name Generator It's actually

SelenNB 2 May 12, 2022
freeCodeCamp Scientific Computing with Python Project for Certification.

Polygon_Area_Calculator freeCodeCamp Python Project freeCodeCamp Scientific Computing with Python Project for Certification. In this project you will

Rajdeep Mondal 1 Dec 23, 2021
๐Ÿ“– Generate markdown API documentation from Google-style Python docstring. The lazy alternative to Sphinx.

lazydocs Generate markdown API documentation for Google-style Python docstring. Getting Started โ€ข Features โ€ข Documentation โ€ข Support โ€ข Contribution โ€ข

Machine Learning Tooling 118 Dec 31, 2022
Explain yourself! Interrogate a codebase for docstring coverage.

interrogate: explain yourself Interrogate a codebase for docstring coverage. Why Do I Need This? interrogate checks your code base for missing docstri

Lynn Root 435 Dec 29, 2022
level2-data-annotation_cv-level2-cv-15 created by GitHub Classroom

[AI Tech 3๊ธฐ Level2 P Stage] ๊ธ€์ž ๊ฒ€์ถœ ๋Œ€ํšŒ ํŒ€์› ์†Œ๊ฐœ ๊น€๊ทœ๋ฆฌ_T3016 ๋ฐ•์ •ํ˜„_T3094 ์„์ง„ํ˜_T3109 ์†์ •๊ท _T3111 ์ดํ˜„์ง„_T3174 ์ž„์ข…ํ˜„_T3182 Overview OCR (Optimal Character Recognition) ๊ธฐ์ˆ 

6 Jun 10, 2022
The OpenAPI Specification Repository

The OpenAPI Specification The OpenAPI Specification is a community-driven open specification within the OpenAPI Initiative, a Linux Foundation Collabo

OpenAPI Initiative 25.5k Dec 29, 2022
A pluggable API specification generator. Currently supports the OpenAPI Specification (f.k.a. the Swagger specification)..

apispec A pluggable API specification generator. Currently supports the OpenAPI Specification (f.k.a. the Swagger specification). Features Supports th

marshmallow-code 1k Jan 01, 2023
Fun interactive program to sort a list :)

LHD-Build-Sort-a-list Fun interactive program to sort a list :) Inspiration LHD Build Write a script to sort a list. What it does It is a menu driven

Ananya Gupta 1 Jan 15, 2022
:blue_book: Automatic documentation from sources, for MkDocs.

mkdocstrings Automatic documentation from sources, for MkDocs. Features Python handler features Requirements Installation Quick usage Features Languag

Timothรฉe Mazzucotelli 1.1k Dec 31, 2022
Jupyter Notebooks as Markdown Documents, Julia, Python or R scripts

Have you always wished Jupyter notebooks were plain text documents? Wished you could edit them in your favorite IDE? And get clear and meaningful diff

Marc Wouts 5.7k Jan 04, 2023
SqlAlchemy Flask-Restful Swagger Json:API OpenAPI

SAFRS: Python OpenAPI & JSON:API Framework Overview Installation JSON:API Interface Resource Objects Relationships Methods Custom Methods Class Method

Thomas Pollet 361 Nov 16, 2022
A plugin to introduce a generic API for Decompiler support in GEF

decomp2gef A plugin to introduce a generic API for Decompiler support in GEF. Like GEF, the plugin is battery-included and requires no external depend

Zion 379 Jan 08, 2023
Explicit, strict and automatic project version management based on semantic versioning.

Explicit, strict and automatic project version management based on semantic versioning. Getting started End users Semantic versioning Project version

Dmytro Striletskyi 6 Jan 25, 2022
This repo contains everything you'll ever need to learn/revise python basics

Python Notes/cheat sheet Simplified notes to get your Python basics right Just compare code and output side by side and feel the rush of enlightenment

Hem 5 Oct 06, 2022
Python document object mapper (load python object from JSON and vice-versa)

lupin is a Python JSON object mapper lupin is meant to help in serializing python objects to JSON and unserializing JSON data to python objects. Insta

Aurรฉlien Amilin 24 Nov 09, 2022
PowerApps-docstring is a console based, pipeline ready application that automatically generates user and technical documentation for Power Apps.

powerapps-docstring PowerApps-docstring is a console based, pipeline ready application that automatically generates user and technical documentation f

Sebastian Muthwill 30 Nov 23, 2022
NetBox plugin that stores configuration diffs and checks templates compliance

Config Officer - NetBox plugin NetBox plugin that deals with Cisco device configuration (collects running config from Cisco devices, indicates config

77 Dec 21, 2022
Make posters from Markdown files.

MkPosters Create posters using Markdown. Supports icons, admonitions, and LaTeX mathematics. At the moment it is restricted to the specific layout of

Patrick Kidger 243 Dec 20, 2022