Skip to content

docs: Comply with Diátaxis #732

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
PierreQuinton wants to merge 4 commits into from
Closed

docs: Comply with Diátaxis #732

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b497813
docs: Rename to to comply with diataxis
PierreQuinton Jun 11, 2026
204a6ba
Update references accordingly. Add a redirect.py file to redirect the…
PierreQuinton Jun 11, 2026
8309823
Merge branch 'main' into dev-docs-diataxis
PierreQuinton Jun 13, 2026
3fb9cbb
Split `examples` into `how_to` and `tutorials`
PierreQuinton Jun 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .github/workflows/checks.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,10 @@ jobs:
working-directory: docs
run: uv run make dirhtml

- name: Verify Redirects
working-directory: docs
run: uv run make redirects-check

- name: Test Documentation
working-directory: docs
run: uv run make doctest
Expand Down
72 changes: 36 additions & 36 deletions README.md
View file
Open in desktop

Large diffs are not rendered by default.

29 changes: 28 additions & 1 deletion docs/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,34 @@ BUILDDIR = build
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile
.PHONY: help Makefile redirects redirects-check

redirects:
@if [ -d "$(BUILDDIR)/dirhtml" ]; then \
python _redirects.py "$(BUILDDIR)/dirhtml"; \
elif [ -d "$(BUILDDIR)/html" ]; then \
python _redirects.py "$(BUILDDIR)/html"; \
else \
echo "No build directory found; run make html or make dirhtml first."; \
fi

redirects-check:
@if [ -d "$(BUILDDIR)/dirhtml" ]; then \
python _redirects.py --check "$(BUILDDIR)/dirhtml"; \
elif [ -d "$(BUILDDIR)/html" ]; then \
python _redirects.py --check "$(BUILDDIR)/html"; \
else \
echo "No build directory found; run make html or make dirhtml first."; \
exit 1; \
fi

html:
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
@python _redirects.py "$(BUILDDIR)/html"

dirhtml:
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
@python _redirects.py "$(BUILDDIR)/dirhtml"

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
Expand Down
Loading
Loading