Sphinx — Sphinx documentation (original) (raw)

Create intelligent and beautiful documentation with ease

📝 Rich Text Formatting

Author in reStructuredTextor MyST Markdownto create highly structured technical documents, including tables, highlighted code blocks, mathematical notations, and more.

🔗 Powerful Cross-Referencing

Create cross-referenceswithin your project, and even across different projects. Include references to sections, figures, tables, citations, glossaries, code objects, and more.

📚 Versatile Documentation Formats

Generate documentation in the preferred formats of your audience, including HTML, LaTeX (for PDF), ePub, Texinfo, and more.

🔌 Fully Extensible

Add custom functionality, via robust extension mechanismswith numerous built-inand third-partyextensions available for tasks like creating diagrams, testing code, and more.

🌍 Internationalization (i18n)

Add documentation translationsmultiple languages to reach a global audience.

🌟 Active Community and Support

Benefit from an active community, with numerous resources, tutorials, forums, and examples.

As used by:

Python¶

Linux Kernel¶

Project Jupyter¶

See below for how to navigate Sphinx's documentation.

Get started¶

These sections cover the basics of getting started with Sphinx, including creating and building your own documentation from scratch.

The Basics

User guide¶

These sections cover various topics in using and extending Sphinx for various use-cases. They are a comprehensive guide to using Sphinx in many contexts and assume more knowledge of Sphinx. If you are new to Sphinx, we recommend starting with Get started.

User guide

Reference guide¶

Reference documentation is more complete and programmatic in nature, it is a collection of information that can be quickly referenced. If you would like usecase-driven documentation, see Get started or User guide.

Reference