Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,9 @@ jobs:
python-version: "3.13"
- run: uv sync --group docs
- run: uv run --group docs mkdocs build --strict
# exclude_docs filters theme files too, and a build stripped of its
# stylesheets is still a green build — deploying bare HTML taught that.
- run: ls site/assets/stylesheets/main.*.min.css
- uses: actions/upload-pages-artifact@v5
with:
path: site/
Expand Down
5 changes: 4 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,12 @@ edit_uri: ""
# subdirectory is local working material that git already ignores and the
# site must too. Excluding directories wholesale is the same kind of promise
# the sdist allowlist makes: an accidental `mkdocs gh-deploy` from a working
# checkout cannot publish anything the repository does not carry.
# checkout cannot publish anything the repository does not carry. The theme
# serves its stylesheets and scripts through this same filter, so its assets
# are let back through by name — without that the site deploys as bare HTML.
exclude_docs: |
*/
!assets/

# CHANGELOG.md lives at the repository root, where a reader who never opens
# the site still finds it. The hook hands that one file to the build as a
Expand Down