Sphinx¶
See also
Sphinx logo¶
Description¶
Sphinx is a tool that makes it easy to create intelligent and beautiful documentation, written by Georg Brandl and licensed under the BSD license.
It was originally created for the new Python documentation, and it has excellent facilities for the documentation of Python projects, but C/C++ is already supported as well, and it is planned to add special support for other languages as well.
Since 2015, Takeshi Komiya is the main maintainer of the sphinx project.
reST Sphinx¶
- reStructuredText Sphinx documentation
conf.pyExamples- sphinx markup
- sphinx domain
- sphinx code
- toctree
- Paragraphs
- Image
- figure
- Substitution
- Lists
- Source Code
- include
- code-block (pygments, highlight)
- rest Tables
- sphinx Hyperlinks
- Sphinx Sections
- Explicit Markup
- Sphinx Directives
- Sphinx Footnotes
- Comments
- Source encoding
- sidebar
- Gotchas
Sphinx extensions (sphinx.ext.*)¶
- sphinx.ext. Sphinx extensions
- sphinx.ext.autodoc
- sphinx.ext.autodoc.typehints (autodoc_typehints) (since sphinx 2.4.0, 2020-02-09)
- sphinx.ext.autosummary (Generate autodoc summaries)
- sphinx.ext.intersphinx link to other projects documentation ! (the killer feature !)
- sphinx.ext.napoleon (Support for NumPy and Google style docstrings)
Sphinx contributed extensions¶
- Contributed sphinx extensions
- Sphinx autorun
- Blockdiag (simple diagram images generator)
- Doxygen contributed extensions
- Sphinx hieroglyph extension
- javasphinx extension
- LinuxDoc Sphinx-doc extensions for sophisticated C developer (NEW, 2016-07)
- sphinx odt2sphinx extension
- rstspreadsheet sphinx extension
- rst2qhc (Qt)
- sphinx report
- Sphinx-tabs extension Tabbed views for Sphinx
- sphinx-js : autodoc-style extraction into Sphinx for your JS project
- sphinx UML extensions
- sphinxcontrib-dashbuilder
- Sphinx excel table
Sphinx examples¶
- Projects using Sphinx
- Very nice doc
- C++ doc (with doxylink, breathe, …)
- Nice doc
- Askbot
- Bottle.py
- Python USB API for Canon digital cameras
- Ceph
- Django
- Exquires
- Dpm
- Eyesopen
- Sphinx gammu documentation
- github2 using sphinx
- Macaron: Python O/R Mapper
- Mediagobelin
- Parcel (html_theme = ‘flask’)
- Pylons
- PysSCes
- Python GTK+ 3 Tutorial
- Python
- Sphinx Prody documentation
- Requests
- Simpy Documentation
- Sphinx
- SQLAlchemy 0.7 Documentation
- Urwid Documentation
- Classic doc
- Non python projects
- Sphinx references
Sphinx themes¶
Sphinx versions¶
- Sphinx versions
- Sphinx 4.0.0 (IN DEVELOPMENT)
- Sphinx 3.0.0 (2020-04-06)
- Sphinx 2.5.0 (NOT RELEASED)
- Sphinx 2.4.0 (2020-02-09) new features (typing) of sphinx.ext.autodoc in sphinx
- Sphinx 2.3.0 (2019-12-15)
- Sphinx 2.2.0 (2019-08-19)
- Sphinx 2.1.0 (2019-06-02)
- Sphinx 2.0.0 (2019-03-28)
- Sphinx 1.6.3 (2017-07-02)
- Sphinx 1.2.3 (2014-09-01)
- Release 1.1.1 (Nov 1, 2011)
- Release 1.1 (Oct 9, 2011)