Sphinx

Resources

See also

docutils - Python library that implements reStructuredText

• Project homepage

• Discussion group

• Online reStructuredText editor

• Guides

  • reStructuredText - Sphinx’s guide to reST

    • Substitutions

  • Sphinx/reST Memo - Condensed, example-based guide to Sphinx & reStructuredText

  • Wiser > Sphinx & reStructuredText - Broad tutorial

    • Escaping whitespace around interpreted text

Documentation

• Directives

  • toctree

• Domains

  • Python

Cross References

• Documentation

  • Labels

  • Documents

  • Domain cross-references

    • Prefix with ! - no reference/hyperlink will be created

    • Prefix with ~ - link text will only be the last component of target

• https://pypi.org/project/sphobjinv/ - Inspect/manipulate objects.inv files

Refence Target	Syntax
Labels	:ref:`label`
Documents	:doc:`path`
Labels (cross-project)	:ref:`project:label`
Documents (cross-project)	:doc:`project:path`

Extensions

• Documentation

• Built-In

  • sphinx.ext.extlinks - Markup to shorten external links

  • sphinx.ext.intersphinx - Link to other projects’ documentation

    • Showing all links of an Intersphinx mapping file

    • Read The Docs: Link to Other Projects’ Documentation With Intersphinx

• Third-Party

  • https://pypi.org/project/sphinx-jinja/ - Include content generated from Jinja templates in Sphinx documents

Themes

• Sphinx-Themes.org

Theme	Examples	Notes
Read The Docs	demo, sphinx-themes	Wyrm - base SASS framework
Guzzle	demo
Typelog	Authlib	Documentation
Klink	demo
TYPO3	demo
PyData	demo, sphinx-themes