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
23 changes: 23 additions & 0 deletions .github/workflows/docs-check.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: Docs build check

on:
pull_request:
paths:
- "docs/**"
- "_zensical.toml"
- "openg2g/**"
- "scripts/gen_api_docs.py"
- "scripts/docs.sh"
- "uv.lock"
- ".github/workflows/docs-check.yml"

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- uses: astral-sh/setup-uv@v7
with:
enable-cache: true
- run: uv sync --only-group docs
- run: uv run --no-sync bash scripts/docs.sh build
7 changes: 7 additions & 0 deletions _zensical.toml
Original file line number Diff line number Diff line change
Expand Up @@ -117,3 +117,10 @@ show_root_full_path = true
members_order = "source"
relative_crossrefs = true
filters = ["!^_"]

# mkdocstrings cross-references like [`Coordinator`][openg2g.coordinator.Coordinator]
# are resolved by the mkdocs-autorefs plugin after Zensical's reference parser has
# already run. Disable Zensical's pre-autorefs warning to avoid flagging refs as
# "unresolved" that autorefs then rewrites correctly in the final HTML.
[project.validation]
unresolved_references = false
Comment thread
jaywonchung marked this conversation as resolved.