Skip to content

Commit ae307ea

Browse files
cofineuri10
andauthored
docs: restructure documentation (#315)
restructure docs navigation with usage/extension hubs and framework sections simplify getting started/installation content with bundle tabs and package matrix update playground UI and runtime, remove SQL panel, add tips modal clean up examples and unused rst files; remove orphaned pages adjust styling, syntax highlighting, and sidebar behavior Co-authored-by: euri10 <benoit.barthelet@gmail.com>
1 parent 452127a commit ae307ea

333 files changed

Lines changed: 4371 additions & 30137 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ target/
3131
.python-version
3232
.ruff_cache
3333
/docs/_build/
34+
docs/autoapi/
3435
coverage.*
3536
setup.py
3637
tmp/

Makefile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -250,12 +250,12 @@ docs-clean: ## Clean documentation build
250250
.PHONY: docs-serve
251251
docs-serve: docs-clean ## Serve documentation locally
252252
@echo "${INFO} Starting documentation server... 📚"
253-
@uv run sphinx-autobuild docs docs/_build/ -j auto --watch sqlspec --watch docs --watch tests --watch CONTRIBUTING.rst --port 8002
253+
@uv run sphinx-autobuild docs docs/_build/ -j 1 --watch sqlspec --watch docs --watch tests --watch CONTRIBUTING.rst --port 8002
254254

255255
.PHONY: docs
256256
docs: docs-clean ## Build documentation
257257
@echo "${INFO} Building documentation... 📝"
258-
@uv run sphinx-build -M html docs docs/_build/ -E -a -j auto -W --keep-going
258+
@PYTHONWARNINGS="ignore::FutureWarning" uv run sphinx-build -M html docs docs/_build/ -E -a -j 1 -W --keep-going
259259
@echo "${OK} Documentation built successfully"
260260

261261
.PHONY: docs-linkcheck

0 commit comments

Comments
 (0)