@@ -100,48 +100,41 @@ version.
100100
101101## Generating the Docs
102102
103- The documentation is built with [ MkDocs] ( https://www.mkdocs.org/ ) using the
104- Material theme, [ mkdocstrings] ( https://mkdocstrings.github.io/ ) for
105- auto-generated API reference from the source, and
106- [ mermaid] ( https://mermaid.js.org/ ) for architecture diagrams. Markdown sources
107- live under ` docs/markdown/ ` .
103+ The documentation is built with [ Sphinx] ( https://www.sphinx-doc.org/ ) using
104+ the [ Furo] ( https://pradyunsg.me/furo/ ) theme,
105+ [ autodoc] ( https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html )
106+ for auto-generated API reference from docstrings,
107+ [ MyST] ( https://myst-parser.readthedocs.io/ ) so that Markdown source files
108+ work alongside reST, and [ sphinxcontrib-mermaid] ( https://github.com/mgaitan/sphinxcontrib-mermaid )
109+ for the architecture diagrams. Sources live under ` docs/source/ ` .
108110
109- Install dev dependencies (including MkDocs and plugins):
111+ Install dev dependencies (including Sphinx, Furo, and the plugins):
110112
111113``` bash
112- uv sync
114+ uv sync --all-extras
113115```
114116
115117Build the HTML docs:
116118
117119``` bash
118- uv run mkdocs build
120+ uv run sphinx-build -b html docs/source docs/ build/sphinx
119121```
120122
121- The output will be in ` docs/build/html/ ` . Open ` docs/build/html/index.html ` in
122- a browser to view locally.
123+ Open ` docs/build/sphinx/index.html ` in a browser to view locally.
123124
124- For a live-reloading preview while editing:
125+ For a live-reloading preview while editing, use
126+ [ sphinx-autobuild] ( https://github.com/sphinx-doc/sphinx-autobuild ) :
125127
126128``` bash
127- uv run mkdocs serve
129+ uv run --with sphinx-autobuild sphinx-autobuild docs/source docs/build/sphinx
128130```
129131
130- Then visit http://127.0.0.1:8000 .
131-
132- To match what CI publishes (warnings become errors — useful when you've
133- touched docstrings):
132+ To match what CI publishes (warnings become errors — useful after touching
133+ docstrings or signatures):
134134
135135``` bash
136- uv run mkdocs build --strict
136+ uv run sphinx- build -W --keep-going -b html docs/source docs/build/sphinx
137137```
138138
139139CI builds the site on every push and deploys ` main ` to GitHub Pages via
140- ` .github/workflows/docs_pages.yaml ` .
141-
142- The legacy Sphinx setup under ` docs/source/ ` is kept temporarily for
143- reference and builds to a separate output directory:
144-
145- ``` bash
146- uv run sphinx-build -b html docs/source docs/build/sphinx
147- ```
140+ ` .github/workflows/docs_pages.yaml ` .
0 commit comments