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
Project documentation with Markdown.

MkDocs Project documentation with Markdown. View the MkDocs documentation. Project release notes. Visit the MkDocs wiki for community resources, inclu

MkDocs 15.6k Jan 02, 2023
Loudchecker - Python script to check files for earrape

loudchecker python script to check files for earrape automatically installs depe

1 Jan 22, 2022
sphinx builder that outputs markdown files.

sphinx-markdown-builder sphinx builder that outputs markdown files Please ★ this repo if you found it useful ★ ★ ★ If you want frontmatter support ple

Clay Risser 144 Jan 06, 2023
An MkDocs plugin to export content pages as PDF files

MkDocs PDF Export Plugin An MkDocs plugin to export content pages as PDF files The pdf-export plugin will export all markdown pages in your MkDocs rep

Terry Zhao 266 Dec 13, 2022
python package sphinx template

python-package-sphinx-template python-package-sphinx-template

Soumil Nitin Shah 2 Dec 26, 2022
A collection of lecture notes, drawings, flash cards, mind maps, scripts

Neuroanatomy A collection of lecture notes, drawings, flash cards, mind maps, scripts and other helpful resources for the course "Functional Organizat

Georg Reich 3 Sep 21, 2022
A collection and example code of every topic you need to know about in the basics of Python.

The Python Beginners Guide: Master The Python Basics Tonight This guide is a collection of every topic you need to know about in the basics of Python.

Ahmed Baari 1 Dec 19, 2021
A simple document management REST based API for collaboratively interacting with documents

documan_api A simple document management REST based API for collaboratively interacting with documents.

Shahid Yousuf 1 Jan 22, 2022
Collections of Beautiful Latex Snippets

HandyLatex Collections of Beautiful Latex Snippets Table 👉 Succinct table with bold separation line and gray text %################## Dependencies ##

Xintao 15 Apr 11, 2022
Credit EDA Case Study Using Python

This case study aims to identify patterns which indicate if a client has difficulty paying their installments which may be used for taking actions such as denying the loan, reducing the amount of loa

Purvi Padliya 1 Jan 14, 2022
Code for our SIGIR 2022 accepted paper : P3 Ranker: Mitigating the Gaps between Pre-training and Ranking Fine-tuning with Prompt-based Learning and Pre-finetuning

P3 Ranker Implementation for our SIGIR2022 accepted paper: P3 Ranker: Mitigating the Gaps between Pre-training and Ranking Fine-tuning with Prompt-bas

14 Jan 04, 2023
This repository outlines deploying a local Kubeflow v1.3 instance on microk8s and deploying a simple MNIST classifier using KFServing.

Zero to Inference with Kubeflow Getting Started This repository houses all of the tools, utilities, and example pipeline implementations for exploring

Ed Henry 3 May 18, 2022
Markdown documentation generator from Google docstrings

mkgendocs A Python package for automatically generating documentation pages in markdown for Python source files by parsing Google style docstring. The

Davide Nunes 44 Dec 18, 2022
API Documentation for Python Projects

API Documentation for Python Projects. Example pdoc -o ./html pdoc generates this website: pdoc.dev/docs. Installation pip install pdoc pdoc is compat

mitmproxy 1.4k Jan 07, 2023
The source code that powers readthedocs.org

Welcome to Read the Docs Purpose Read the Docs hosts documentation for the open source community. It supports Sphinx docs written with reStructuredTex

Read the Docs 7.4k Dec 25, 2022
script to calculate total GPA out of 4, based on input gpa.csv

gpa_calculator script to calculate total GPA out of 4 based on input gpa.csv to use, create a total.csv file containing only one integer showing the t

Mohamad Bastin 1 Feb 07, 2022
📖 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
Que es S4K Builder?, Fácil un constructor de tokens grabbers con muchas opciones, como BTC Miner, Clipper, shutdown PC, Y más! Disfrute el proyecto. <3

S4K Builder Este script Python 3 de código abierto es un constructor del muy popular registrador de tokens que está en [mi GitHub] (https://github.com

SadicX 1 Oct 22, 2021
The purpose of this project is to share knowledge on how awesome Streamlit is and can be

Awesome Streamlit The fastest way to build Awesome Tools and Apps! Powered by Python! The purpose of this project is to share knowledge on how Awesome

Marc Skov Madsen 1.5k Jan 07, 2023
python wrapper for simple-icons

simpleicons Use a wide-range of icons derived from the simple-icons repo in python. Go to their website for a full list of icons. The slug version mus

Sachin Raja 14 Nov 07, 2022