Sphinx¶
See also
- https://github.com/sphinx-doc/sphinx
- https://en.wikipedia.org/wiki/Sphinx_(documentation_generator)
- https://github.com/yoloseem/awesome-sphinxdoc
- http://sphinx-doc.org/
- http://sphinx-doc.org/latest/
- http://sphinx-doc.org/examples.html
- http://rest-sphinx-memo.readthedocs.org/en/latest/Project.html
- http://rest-sphinx-memo.readthedocs.org/en/latest/References.html
- http://redaction-technique.org/index.html
- Description
- Sphinx source code (Sphinx dev guide)
- Sphinx applications
- reST Sphinx
- Sphinx extensions and contributed extensions
- Sphinx howto
- Hébergeurs Sphinx
- Sphinx examples
- Sphinx i18n
- Sphinx installation
- Sphinx people
- Sphinx tutorials
- Tools for Sphinx
- Sphinx themes
- Sphinx templating
- Sphinx translations
- Sphinx versions
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.
reST Sphinx¶
- reStructuredText Sphinx documentation
conf.py
Examples- sphinx markup
- sphinx domain
- sphinx code
- toctree
- Paragraphs
- Image
- figure
- kfigure : Scalable figure and image handling (needs linuxdoc extension, 2016-2017)
- 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 and contributed extensions¶
- Sphinx 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-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
- Renpy (2013)
- Requests
- Simpy Documentation
- Sphinx
- SQLAlchemy 0.7 Documentation
- Urwid Documentation
- Wikimedia sphinx projects
- Classic doc
- Non python projects
- Sphinx references