Skip to content

fix(docs): skip removed-type modules during API documentation builds #1428

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

Merged
bokelley merged 1 commit into from
Oct 7, 2026
Merged

fix(docs): skip removed-type modules during API documentation builds #1428

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 12 additions & 1 deletion .github/workflows/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,18 @@ jobs:

- name: Build docs
run: |
pdoc --html --output-dir docs/api adcp
python - <<'PY'
import adcp
from pdoc import cli

# Parent-package exclusions are checked before pdoc imports submodules.
# Keep in sync with the tombstones restored by scripts/post_generate_fixes.py.
adcp.__pdoc__ = {
**getattr(adcp, "__pdoc__", {}),
"types.domains.enums.format_category": False,
}
cli.main(cli.parser.parse_args(["--html", "--output-dir", "docs/api", "adcp"]))
PY

- name: Configure Pages
uses: actions/configure-pages@v6
Expand Down
Loading