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.
Table of Contents
- Documenting Your Project With Sphinx
Exercises for the Sphinx Tutorial that Brandon Rhodes often gives at PyCon.
http://sphinx-doc.org/rest.html
http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html
http://docutils.sourceforge.net/docs/ref/rst/directives.html
http://sphinx-doc.org/markup/index.html
http://sphinx-doc.org/glossary.html
http://sphinx-doc.org/extdev/index.html
https://bitbucket.org/birkenfeld/sphinx-contrib
- sphinx-git
git Changelog for Sphinx.
- sphinxcontrib-autoprogram
Provides an automated way to document CLI programs.
- sphinxcontrib-blockdiag
Sphinx extension for embedding blockdiag diagrams.
- sphinxcontrib-httpdomain
Provides a Sphinx domain for describing RESTful HTTP APIs.
- flask-sphinx-themes
Sphinx Themes for Flask related projects and Flask itself.
- krTheme Sphinx Style
Sphinx theme Kenneth Reitz use for most projects e.g. Requests.
- sphinx_rtd_theme
Sphinx theme for readthedocs.org.
- sphinxjp.themes.basicstrap
Sphinx theme built with responsive Bootstrap.
- 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 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.