spb/tools-spboucher-ai

1{2  "slug": "sphinx",3  "name": "Sphinx",4  "aliases": ["sphinx-doc"],5  "vendor": { "name": "Sphinx team", "slug": "sphinx-team", "website": "https://www.sphinx-doc.org" },6  "homepage_url": "https://www.sphinx-doc.org/en/master/",7  "docs_url": "https://www.sphinx-doc.org/en/master/usage/index.html",8  "repo_url": "https://github.com/sphinx-doc/sphinx",9  "license_url": "https://github.com/sphinx-doc/sphinx/blob/master/LICENSE.rst",10  "product_type": "application",11  "product_status": "active",12  "summary": "Python documentation generator using reStructuredText or MyST Markdown with cross-referencing, API autodoc and output to HTML, PDF via LaTeX, ePub and man pages",13  "description": "Sphinx is a documentation generator created for the Python language documentation and maintained by the Sphinx team under a BSD-2-Clause license. Source files are written in reStructuredText, or in Markdown through the MyST parser, and compiled into HTML, LaTeX and PDF, ePub, Texinfo and man pages. Its directive and role system provides semantic markup for code objects, cross-references that resolve across pages and even across projects (intersphinx), indices, glossaries and math rendering.\n\nThe autodoc extension pulls API documentation from Python docstrings, and domains exist for C, C++, JavaScript and other languages, which is why Sphinx remains the standard for scientific Python libraries and for projects hosted on Read the Docs. Themes such as Furo and PyData Sphinx Theme modernize the output. Sphinx's cost is complexity: reStructuredText syntax is stricter than Markdown, configuration in `conf.py` grows with extensions, and builds of large projects are slower than those of lighter generators. For a simple Markdown site MkDocs is often sufficient, but for documentation that needs rigorous cross-referencing or print output Sphinx is the more capable tool.",14  "capabilities": ["reStructuredText and MyST Markdown sources", "Cross-references within and across projects (intersphinx)", "API documentation from docstrings (autodoc)", "Multiple output formats including PDF via LaTeX", "Extension and theme ecosystem", "Domains for several programming languages"],15  "workflows": ["Generate a scientific library's API reference with autodoc", "Build both a website and a PDF manual from one source", "Host versioned documentation on Read the Docs"],16  "advantages": ["Rigorous cross-referencing and indices", "Print-quality output through LaTeX", "Long-established with many extensions"],17  "limitations": ["reStructuredText has a learning curve", "Configuration grows complex with extensions", "Slower builds on large projects"],18  "prerequisites": ["Python; a LaTeX distribution for PDF output"],19  "audiences": ["Python and scientific library maintainers", "Technical writers needing print output"],20  "alternatives": ["mkdocs", "docusaurus", "quarto"],21  "comparison_notes": "MkDocs is simpler and Markdown-only, with API docs added through plugins; Docusaurus is React-based with versioning and localization built in. Quarto also produces HTML and PDF from a single source but is oriented to computational documents and reports rather than software reference documentation.",22  "categories": [{ "slug": "documentation", "primary": true }, { "slug": "latex-typesetting" }],23  "tags": ["documentation", "python", "latex", "open-source", "static-site"],24  "use_cases": ["typeset-documents"],25  "operating_systems": ["macos", "linux", "windows"],26  "execution_modes": ["local", "cloud"],27  "interfaces": ["cli", "library"],28  "deployment_models": ["desktop"],29  "integrations": ["Read the Docs", "MyST", "LaTeX", "Jupyter (nbsphinx)", "GitHub Actions"],30  "data_formats": ["reStructuredText", "Markdown", "HTML", "LaTeX", "PDF", "ePub"],31  "languages": ["Python"],32  "source_model": "open-source",33  "license_spdx": "BSD-2-Clause",34  "pricing_model": ["open-source", "free"],35  "self_hostable": true,36  "sources": [37    { "url": "https://www.sphinx-doc.org/en/master/", "type": "official_site", "title": "Sphinx documentation", "supports": ["name", "summary"], "checked_at": "2026-11-02" },38    { "url": "https://www.sphinx-doc.org/en/master/usage/index.html", "type": "official_docs", "title": "Using Sphinx", "supports": ["capabilities"], "checked_at": "2026-11-02" },39    { "url": "https://github.com/sphinx-doc/sphinx/blob/master/LICENSE.rst", "type": "license_page", "supports": ["license_spdx", "source_model"], "checked_at": "2026-11-02" }40  ],41  "confidence": "high",42  "discovery_method": "editorial-research",43  "depth": "standard",44  "editorial_status": "reviewed",45  "visibility": "public",46  "featured": false,47  "author": "batch-B1"48}49