Skip to content

Commit a3ad8a7

Browse files
authored
fix(docs): skip removed-type modules during API documentation builds (#1428)
Co-authored-by: Brian O'Kelley <134922+bokelley@users.noreply.github.com>
1 parent 43910ce commit a3ad8a7

1 file changed

Lines changed: 12 additions & 1 deletion

File tree

‎.github/workflows/docs.yml‎

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,18 @@ jobs:
3737
3838
- name: Build docs
3939
run: |
40-
pdoc --html --output-dir docs/api adcp
40+
python - <<'PY'
41+
import adcp
42+
from pdoc import cli
43+
44+
# Parent-package exclusions are checked before pdoc imports submodules.
45+
# Keep in sync with the tombstones restored by scripts/post_generate_fixes.py.
46+
adcp.__pdoc__ = {
47+
**getattr(adcp, "__pdoc__", {}),
48+
"types.domains.enums.format_category": False,
49+
}
50+
cli.main(cli.parser.parse_args(["--html", "--output-dir", "docs/api", "adcp"]))
51+
PY
4152
4253
- name: Configure Pages
4354
uses: actions/configure-pages@v6

0 commit comments

Comments
 (0)