awesome-sphinxdoc

Sphinx is a powerful and flexible documentation generator that assists in effectively managing and publishing documentation for various projects. This page presents a curated list of resources designed to help you leverage Sphinx to its fullest potential. Explore official documentation, tutorials, extensions, themes, and other valuable assets to significantly enhance your documentation workflow.

Can't find the link you're looking for?
Please add a link! You can create a pull request on GitHub ygzgxyz/awesome-sphinxdoc. Your contributions are always welcome!

This project is inspired by the various awesome lists in the community.
Licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.

Sphinx는 다양한 프로젝트의 문서를 효과적으로 관리하고 게시하는 데 도움을 주는 강력하고 유연한 문서 생성기입니다. 이 페이지는 Sphinx를 최대한 활용하는 데 도움이 되도록 엄선된 리소스 목록을 제공합니다. 공식 문서, 튜토리얼, 확장 기능, 테마 및 기타 유용한 자료를 탐색하여 문서화 작업을 크게 향상시키세요.

찾으시는 링크가 없으신가요?
링크를 추가해주세요! GitHub에서 풀 리퀘스트를 생성할 수 있습니다 ygzgxyz/awesome-sphinxdoc. 여러분의 기여는 언제나 환영합니다!

이 프로젝트는 커뮤니티의 다양한 awesome lists 에서 영감을 받았습니다.
크리에이티브 커먼즈 저작자표시-동일조건변경허락 4.0 국제 라이선스 하에 라이선스가 부여됩니다。

Sphinxは、さまざまなプロジェクトのドキュメントを効果的に管理および公開するのに役立つ、強力で柔軟なドキュメントジェネレーターです。このページでは、Sphinxを最大限に活用するのに役立つ厳選されたリソースのリストを紹介します。公式ドキュメント、チュートリアル、拡張機能、テーマ、その他の貴重なアセットを探索して、ドキュメント作成ワークフローを大幅に強化してください。

お探しのリンクが見つかりませんか？
リンクを追加してください！GitHubでプルリクエストを作成できます ygzgxyz/awesome-sphinxdoc。皆様のご貢献を歓迎いたします！

このプロジェクトは、コミュニティの様々な awesome lists に触発されています。
クリエイティブ・コモンズ表示-継承 4.0 国際ライセンスの下でライセンスされています。

Sphinx 是一个功能强大且灵活的文档生成器，可帮助有效管理和发布各种项目的文档。此页面提供了精选资源列表，旨在帮助您充分利用 Sphinx 的潜力。探索官方文档、教程、扩展、主题和其他有价值的资产，以显著增强您的文档工作流程。

找不到您要找的链接？
请添加链接！您可以在 GitHub 上创建拉取请求 ygzgxyz/awesome-sphinxdoc。欢迎您的贡献！

本项目受到社区中各种 awesome lists 的启发。
根据知识共享署名-相同方式共享 4.0 国际许可协议获得许可。

ablog: ABlog is a Sphinx extension that converts any documentation or personal website project into a full-fledged blog with atom feeds, archive pages, blog sidebars, Disqus integration, Font-Awesome integration and easy GitHub Pages deploys blogging extension
Alabaster: Alabaster is a visually (c)lean, responsive, configurable theme for the Sphinx documentation system. theme
autoclasstoc: Make easier-to-navigate class documentation. autodoc extension
breathe: ReStructuredText and Sphinx bridge to Doxygen. api-docs extension language-support
cornice.ext.sphinxext: Sphinx extension to build RESTful HTTP API documentation from Pyramid Cornice docstrings. api-docs extension integration
crate-docs-theme: This project provides a Sphinx theme for Crate's documentation that is compatible with ReadTheDocs. theme
django-sphinxdoc: Integrate Sphinx documentation into a Django-powered website. Allows you to use your sites templates, auth and so on. Offers search via Haystack. integration
Documenting Your Project With Sphinx: Exercises for the Sphinx Tutorial that Brandon Rhodes often gives at PyCon. tutorial
docxsphinx: Sphinx extension for building Microsoft Word docx files. builder extension
flask-sphinx-themes: Sphinx Themes for Flask related projects and Flask itself. theme
ghp-import: Script to overwrite a gh-pages/master branch with a .nojekyll file for GitHub Pages. publishing tool
InstantRst: A vim plugin for preview rst document instantly. integration tool
javasphinx: Sphinx extension for documenting Java projects. extension language-support
Jupyter Book: Jupyter Book builds books into formats like HTML and PDF from MyST Markdown and Jupyter notebooks with Sphinx. Jupyter Books can include interactive Jupyter notebooks, interactive data visualizations, and comments and annotations. authoring notebooks tool
krTheme Sphinx Style: Sphinx theme Kenneth Reitz uses for most projects e.g. Requests. theme
mdn-sphinx-theme: This is a version of the Mozilla Developer Network theme, for the Sphinx documentation engine. theme
MyST: MyST allows you to write Sphinx documentation entirely in markdown. MyST markdown provides a markdown equivalent of the reStructuredText syntax, meaning that you can do anything in MyST that you can do with reStructuredText. It is an attempt to have the best of both worlds: the flexibility and extensibility of Sphinx with the simplicity and readability of Markdown. authoring
nbsphinx: Parse, execute, and generate output from Jupyter notebooks as HTML and LaTeX. Markdown in .ipynb is converted to RST with Pandoc. Markdown cells may contain toctree markup for generating tables of contents including .ipynb and .rst files. authoring extension notebooks
numpydoc: NumPy's Sphinx extensions. autodoc extension
Okydoky: Automated docs builder using Sphinx/GitHub/Distribute for private use. publishing tool
ome-documentation: Sphinx-based documentation for the Open Microscopy Environment. example
Read the Docs: Read the Docs hosts documentation, making it fully searchable and easy to find. You can import your docs using any major version control system, including Mercurial, Git, Subversion, and Bazaar. It supports webhooks so your docs get built when you commit code. There's also support for versioning so you can build docs from tags and branches of your code in your repository. A full list of features is available. hosting publishing
Releases: A Sphinx changelog-generating extension. extension utility
riv.vim: ReStructured text editing extensions for Vim, GVim, MacVim; optionally with InstantRst gevent live reload. integration tool
solar-theme: Solar is an attempt to create a theme for the Python Sphinx documentation generator based on the Solarized color scheme. theme
Sphinx Readable Theme: A clean and readable Sphinx theme with focus on autodoc – documentation from docstrings. theme
Sphinx to GitHub: Script to prepare Sphinx html output for GitHub Pages. publishing tool
sphinx-autobuild: Watch a Sphinx directory and rebuild the documentation when a change is detected. publishing tool
sphinx-autodoc-annotation: Use Python 3 annotations in sphinx-enabled docstrings. autodoc extension
sphinx-autodoc-typehints: Type hints support for the Sphinx autodoc extension autodoc extension
sphinx-better-theme: A theme for Sphinx that looks nice, is easy to style with CSS, works well on small screens and mobile devices, and organizes the page better. theme
sphinx-bootstrap-theme: Integrates Bootstrap CSS/Javascript framework responsive design with any Bootswatch CSS themes. theme
sphinx-comments: Add comments and annotation functionality to your Sphinx website. extension utility
sphinx-fortran-extension: A Fortran domain and autodocumentation module for Sphinx. extension language-support
sphinx-foundation-theme: Theme based on the Foundation 4 CSS framework. theme
sphinx-gallery: Sphinx extension for automatic generation of an example gallery. example extension
sphinx-git: git Changelog for Sphinx. extension utility
sphinx-gitstamp: Makes the git timestamp for each page available to HTML templates. extension utility
sphinx-gui: Desktop GUI for editing Sphinx docs. tool
sphinx-guzzle-theme: Sphinx theme used by Guzzle: http://guzzlephp.org theme
sphinx-hbp-theme: HumanBrainProject Collaboratory Sphinx Theme. theme
sphinx-intl: Sphinx utility that make it easy to translate and to apply translation. i18n tool
sphinx-jekyll-builder: sphinx builder that outputs jekyll compatible markdown files with frontmatter builder extension
sphinx-jsonschema: Turns a jsonschema into an integral part of your documentation. Useful when you want a single source for both validation and documentation of your JSON entities. api-docs extension
sphinx-markdown-builder: Sphinx builder that outputs markdown files. authoring builder extension
sphinx-markdown-sample: Markdown based sphinx the documentation generator sample. authoring example
sphinx-me: Wraps your README-only projects in a dynamic Sphinx shell for hosting on Read the Docs. publishing tool
sphinx-nameko-theme: Forked from Sphinx Readable Theme, combined with elements of the Read The Docs theme. theme
Sphinx-Needs: Sphinx-Needs allows the definition, linking, and filtering of need-objects: requirements, specifications, implementations, test cases, and more. extension utility
Sphinx-prompt: Sphinx directive to add unselectable prompt. extension utility
sphinx-py3doc-enhanced-theme: A theme based on the theme of https://docs.python.org/3/ with some responsive enhancements. theme
Sphinx-pyreverse: Simple sphinx wrapper around pyreverse (from pylint suit) to generate UML diagrams from modules. diagram extension
sphinx-reredirects: The extension for Sphinx documentation projects that handle redirects for moved pages. extension utility
sphinx-revealjs: Sphinx extension with theme to generate Reveal.js presentation builder extension
sphinx-server: A universal Sphinx Server based on sphinx-autobuild with Docker support that can be used in production (self-hosted) and for documentation development, bundled with PlantUML, Graphviz and HTTP authentication. hosting publishing tool
sphinx-sitemap: sphinx-sitemap silently generates a sitemap for HTML builds. extension publishing
sphinx-tags: A tiny Sphinx extension that implements blog-style tags for documentation. blogging extension
sphinx-test-reports: Sphinx-Test-Reports shows test results of your unit tests inside your sphinx documentation. extension testing
sphinx-theme-graphite: A slightly muted light-on-dark theme for the Sphinx document generator using only CSS. theme
sphinx-typo3-theme: Modern, responsive, standalone Sphinx theme for TYPO3 documentation. Available from PyPi. theme
sphinx_adc_theme: The Apple Developer Connection theme for sphinx theme
sphinx_rtd_theme: Sphinx theme for readthedocs.io. theme
sphinxcontrib-autojs: The auto JavaScript documentation Sphinx extension. extension language-support
sphinxcontrib-autoprogram: Provides an automated way to document CLI programs. api-docs extension
sphinxcontrib-blockdiag: Sphinx extension for embedding blockdiag diagrams. diagram extension
sphinxcontrib-cldomain: Common Lisp domain for Sphinx. extension language-support
sphinxcontrib-constdata: Extension that allows showing values, listing tables, and generating links from CSV, JSON and YAML files. Instead of hard-coding values in the text, you write constants or queries replaced with value(s) from the external file(s). If the file contains language-sensitive strings, they can be translated with the rest of the Sphinx docs. extension utility
sphinxcontrib-docbookrestapi: Sphinx extension that generates documentation for api-site from RST files. api-docs extension
sphinxcontrib-fulltoc: Extension for Sphinx to make the sidebar show a full table of contents instead of just the local headings. extension utility
sphinxcontrib-httpdomain: Provides a Sphinx domain for describing RESTful HTTP APIs. Also supports reflection for Flask, Bottle, and Tornado apps. api-docs extension
sphinxcontrib-mermaid: This extension allows you to embed Mermaid graphs in your documents, including general flowcharts, sequence diagrams, gantt diagrams and more. diagram extension
sphinxcontrib-napoleon: Napoleon is a pre-processor that parses NumPy and Google style docstrings. autodoc extension
Sphinxcontrib-packages: A sphinx extension to list tools installed on the machine generating the documentation (python versions, binaries, python packages, LaTeX packages, etc.). Useful to know which tools are installed on Readthedocs when writing your own extension. extension utility
sphinxcontrib-programoutput: Sphinx extension to include program output into documents. extension utility
Sphinxcontrib-proof: Sphinx extension to typeset definitions, theorems, proofs, etc. extension utility
sphinxcontrib-svg2pdfconverter: Sphinx SVG to PDF Converter Extension builder extension
sphinxext-rediraffe: This Sphinx extension redirects non-existent pages to working pages. Rediraffe can also check that deleted or renamed files in your git repo are redirected. extension utility
sphinxjp.themes.basicstrap: Sphinx theme built with responsive Bootstrap. theme
sphinxtrap-theme: Sphinxtrap is a minimalist bootstrap2-based + fontawesome sphinx theme. theme
sphobjinv: sphobjinv is a Python package and command-line tool for inspection and manpulation of the objects inventories (objects.inv files) generated by Sphinx's html builder, allowing simple determination of correct cross-reference syntax and construction of objects.inv files for documentation sets not created in Sphinx. tool
sublee-sphinx-themes: Sphinx themes Heungsub Lee uses for his projects e.g. Energy, Korean, Ranking, TrueSkill. theme
swagger-plugin-for-sphinx: This is a handy plugin to bring Swagger and Sphinx together. api-docs extension integration
tinkerer: Blog engine static HTML5 generator with categories, tags, landing page, nav sidebar, RSS powered by Sphinx and responsive Jinja templates. blogging tool
Tut: Tut is a tool that helps you write tutorial style documentation using Sphinx. extension tutorial
TYPO3 documentation: Official documentation and guides for TYPO3 users and developers. example
vimbuilder: Sphinx extension to create Vim help files. builder extension integration