Sphinx¶
Create intelligent and beautiful documentation with ease
📝 Rich Text Formatting
Author inreStructuredTextorMyST Markdownto create highly structured technical documents,including tables, highlighted code blocks, mathematical notations, and more.
🔗 Powerful Cross-Referencing
Createcross-referenceswithin your project,and even acrossdifferent projects.Include references tosections, figures, tables, citations, glossaries, code objects,and more.
📚 Versatile Documentation Formats
Generate documentation in the preferred formats of your audience, includingHTML, LaTeX (for PDF), ePub, Texinfo,and more.
🎨 Extensive Theme Support
Create visually appealing documentation,with a wide choice ofbuilt-inandthird-party HTML themesand the ability to customizeorcreate new themes.
🔌 Fully Extensible
Add custom functionality,via robustextension mechanismswith numerousbuilt-inandthird-partyextensions available for tasks likecreating diagrams, testing code, and more.
🛠️ Automatic API Documentation
Generate API documentation forPython, C++ and othersoftware domains,manually orautomatically from docstrings,ensuring your code documentationstays up-to-date with minimal effort.
🌍 Internationalization (i18n)
Add documentationtranslationsmultiple languages to reach a global audience.
🌟 Active Community and Support
Benefit from anactive community,with numerous resources, tutorials, forums, and examples.
See below for how to navigate Sphinx’s documentation.
See also
TheSphinx documentation Table of Contents hasa full list of this site’s pages.
Get started¶
These sections cover the basics of getting started with Sphinx, includingcreating and building your own documentation from scratch.
User guide¶
These sections cover various topics in using and extending Sphinx for varioususe-cases. They are a comprehensive guide to using Sphinx in many contexts andassume more knowledge of Sphinx. If you are new to Sphinx, we recommendstarting withGet started.
Community guide¶
Sphinx is community supported and welcomes contributions from anybody.The sections below should help you get started joining the Sphinx communityas well as contributing.
See theSphinx contributors’ guide if you wouldlike to contribute to the project.
Reference guide¶
Reference documentation is more complete and programmatic in nature, it is acollection of information that can be quickly referenced. If you would likeusecase-driven documentation, seeGet started orUser guide.
Reference
- Command-line tools
- Configuration
- Extensions
- reStructuredText
- Glossary
- Changelog
- Projects using Sphinx
- Documentation using the alabaster theme
- Documentation using the classic theme
- Documentation using the sphinxdoc theme
- Documentation using the nature theme
- Documentation using another builtin theme
- Documentation using Read the Docs Sphinx Theme
- Documentation using Sphinx Bootstrap Theme
- Documentation using PyData Sphinx Theme
- Documentation using Furo theme
- Documentation using a custom theme or integrated in a website
- Homepages and other non-documentation sites
- Books produced using Sphinx
- Theses produced using Sphinx
- Projects integrating Sphinx functionality