Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
ec0cdc0
Add a docs build gate that fails on any site build warning
zeevmoney Oct 4, 2026
5e09604
Build the API reference site in a docs job that CI needs
zeevmoney Oct 4, 2026
ee6ecb6
Deploy the API reference site to GitHub Pages on release
zeevmoney Oct 4, 2026
aa5a2da
Group the docs tools' Dependabot updates in their own PR
zeevmoney Oct 4, 2026
20ec99f
Add a Griffe extension that shows the SDK as type checkers see it
zeevmoney Oct 4, 2026
00b4ac9
Link the migration skill from MIGRATION.md by URL
zeevmoney Oct 4, 2026
0b6d8c4
Add the API reference site
zeevmoney Oct 4, 2026
13ce82d
Document the API reference site
zeevmoney Oct 4, 2026
e65dd99
Merge the API reference site (PER-16775)
zeevmoney Oct 4, 2026
b5b5694
Merge the docs build gate, CI job and deploy workflow (PER-16775)
zeevmoney Oct 4, 2026
b0b093b
Document the docs build gate and deploy workflow in CONTRIBUTING
zeevmoney Oct 4, 2026
a6b1780
Correct the docs build gate's note on uv errors
zeevmoney Oct 4, 2026
a2f53a4
Point the docs config comments at the docs build gate
zeevmoney Oct 4, 2026
631fb62
Group pymdown-extensions with the other docs tools for Dependabot
zeevmoney Oct 4, 2026
35f7945
Say the site documents the models the methods use, not every model
zeevmoney Oct 4, 2026
b4bc0e3
Fail the docs gate on a warning from any logger
zeevmoney Oct 4, 2026
928ac13
List the error that stopped the docs build in the gate's verdict
zeevmoney Oct 4, 2026
3f8fe38
Check every link in the built docs site, not only those in docs/
zeevmoney Oct 4, 2026
0b9c1f8
Show wait_for_sync() as returning a context manager in the docs
zeevmoney Oct 4, 2026
f889c17
Read _typing.TYPE_CHECKING blocks in the docs Griffe extension
zeevmoney Oct 4, 2026
ed40b6e
Deploy the docs when a prerelease is changed to a release
zeevmoney Oct 4, 2026
4f9b347
Say what configure-pages checks in the docs deploy workflow
zeevmoney Oct 4, 2026
6b7c5e2
Note that the docs deploy does not wait for the PyPI upload
zeevmoney Oct 4, 2026
2094957
Check that CI and the docs deploy set up the same uv and Python
zeevmoney Oct 4, 2026
af2c42b
Say in CONTRIBUTING that the docs gate also fails on broken links
zeevmoney Oct 4, 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
7 changes: 7 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,13 @@ updates:
# runtime floor bumps grouped below, so they get a PR of their own.
lint-tools:
patterns: ["ruff", "mypy", "typos"]
# The docs group's site builder, the API reference plugin and parser, and
# the Markdown extensions mkdocs.yml enables (PER-16775). Zensical is
# alpha, so any release can change what the docs job's gate sees; a bump
# that breaks the site build gets a PR of its own rather than holding up
# the runtime floor bumps.
docs-tools:
patterns: ["zensical", "mkdocstrings*", "griffe*", "pymdown-extensions"]
minor-and-patch:
update-types: ["minor", "patch"]
ignore:
Expand Down
380 changes: 380 additions & 0 deletions .github/scripts/check_docs_build.py

Large diffs are not rendered by default.

3 changes: 2 additions & 1 deletion .github/scripts/pytest.ini
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
# configuration in pyproject.toml ([tool.pytest]), whose testpaths and
# asyncio_mode belong to the SDK's suite. These tests need only pytest and the
# standard library, though test_ci_checks.py also runs bash, jq, yq (mikefarah
# v4) and shellcheck. They warn about nothing: any warning is an error.
# v4) and shellcheck, and test_check_docs_build.py runs yq. They warn about
# nothing: any warning is an error.
[pytest]
# strict_config, strict_markers, strict_xfail and strict_parametrization_ids.
strict = true
Expand Down
Loading
Loading