Sphinx Documentation Generator

Sphinx is a powerful documentation generation tool created by Georg Brandl for the Python project in 2008, now used by the official Python documentation and thousands of open-source projects, providing reStructuredText as the primary markup language with extensions for Markdown, generating output in HTML, PDF, ePub, LaTeX, man pages, and plain text, featuring automatic API documentation extraction from docstrings, cross-referencing, indexing, search, and a rich extension ecosystem, adopted by Python, Django, Flask, SQLAlchemy, LLVM, Linux Kernel, and the majority of Python ecosystem projects for their official documentation. The reStructuredText markup language provides a powerful, extensible text format with directives for code blocks with syntax highlighting through Pygments, admonitions for notes, warnings, and tips, tables, figures with captions, mathematical formulas through MathJax, and custom directives through extensions, with cross-referencing between sections, figures, code objects, and glossary terms using roles that create clickable links in the generated documentation. The autodoc extension automatically extracts docstrings from Python modules, classes, functions, and methods, generating API documentation directly from source code with type annotations, parameter descriptions, return values, and exceptions documented in standard docstring formats including Google, NumPy, and Sphinx native styles, with automatic inheritance diagram generation through the inheritance diagram extension. The theme system includes built-in themes and the popular Read the Docs theme. The internationalization supports multiple languages. The C and C++ domain support. The intersphinx extension links to other projects documentation. The LaTeX output enables print-quality PDF documentation. Designed by Georg Brandl. Designed for Python projects.