Sphinx
install
mkdir <site>
cd <site>
uv venv
.venv\Scripts\activate
uv pip install furo myst-parser
usage
sphinx-quickstart
# make clean
make html
# uv pip install sphinx-autobuild
# sphinx-autobuild . _bulid
reference
- #document Create Documentation with RST, Sphinx, Sublime, and GitHub — RST | Sphinx | Sublime | GitHub documentation
- #document Sphinx — Sphinx documentation
- #sheet radeklat/sphinx-rest-cheatsheet
resource
mark
- #theme Furo
- MyST-Parser
- Sphinx Inline Tabs
- sphinx-autobuild
- sphinx-copybutton
- sphinx-external-toc
- sphinxcontrib-asciinema
- sphinxcontrib-video
- sphinxext-photofinish
later
extra
cache
- #lsp Esbonio
- #themes sphinx-themes.org
- #translate sphinx-intl
- atsphinx-mini18n
- autoclasstoc
- Color schemed images for Sphinx
- doc8
- docsig
- DOCtor-RST
- Jupyter Sphinx Extensions
- PDG role for Sphinx
- Pharaoh
- Read the Docs Sphinx Theme
- Simple Sphinx XML Sitemap Extension
- Sphinx Callouts
- Sphinx CodeLinks
- Sphinx Combine
- Sphinx Comments
- Sphinx DataTables
- Sphinx DataTables
- Sphinx extension: Iframes
- Sphinx Github Changelog
- Sphinx Graph
- Sphinx Indexed Definitions
- Sphinx llms.txt generator
- Sphinx Minecraft
- Sphinx Prompt
- Sphinx Reference Project
- Sphinx Sitemap Generator Extension
- Sphinx Substitution Extensions
- sphinx-all-contributors
- sphinx-api-relink
- sphinx-automodapi
- sphinx-codeautolink
- sphinx-design
- sphinx-diagram-connect
- Sphinx-Gallery
- sphinx-gha
- sphinx-issues
- sphinx-issues
- sphinx-js
- sphinx-mdinclude
- sphinx-mdx-builder
- sphinx-needs
- sphinx-nested-apidoc
- sphinx-notfound-page
- sphinx-polyversion
- sphinx-preview
- sphinx-pybtex-etal-style
- sphinx-reredirects
- sphinx-revealjs
- Sphinx-testify
- sphinx_click_custom
- sphinx_lfs_content
- sphinxcontrib-bibtex
- sphinxcontrib-constdata
- sphinxcontrib-fulltoc
- sphinxcontrib-images
- sphinxcontrib-jsontable
- sphinxcontrib-mermaid
- sphinxcontrib-programoutput
- sphinxcontrib.autoprogram
- sphinxcontrib.external-links
- sphinxnotes-project
- SPHinXsys
1
2