Skip to content

Commit

Permalink
Fix "Render docs" CI job (#628)
Browse files Browse the repository at this point in the history
Hopefully fixing two issues that have started being hit in the "Render
docs" CI job:
* `podman pod create` failing with "initializing source
docker://k8s.gcr.io/pause:3.5: Requesting bear token: invalid status
code from registry 404 (Not Found)", reported at
#625 (comment)
and seen in other PRs too.
* Fixed by updating podman in the CI, since doc generation involves
running podman commands.
* `ModuleNotFoundError: No module named 'griffe.collections'` reported
at
#625 (comment)
and seen in other PRs too.
* Fixed by updating doc package dependencies and pinning a couple more
indirect dependencies (I think the lack of pinning `griffe` while
pinning to an older version of `mkdocstrings-python` was the
problem...).
  • Loading branch information
LewisGaul authored Sep 5, 2024
1 parent 69b2ac3 commit 9da040b
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 8 deletions.
4 changes: 3 additions & 1 deletion .github/workflows/python-package.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,10 @@ jobs:
python-version: 3.8
- name: prepare
run: |
./scripts/ci-podman-update.sh
pip install -U pip wheel
pip install -r ./requirements.txt -r docs/requirements.txt -e .
python docs/autogen.py
./docs/autogen.py
cp -r docs/generated_sources ./generated_sources
cp docs/mkdocs.yml ./
- name: Render
Expand Down
2 changes: 2 additions & 0 deletions docs/autogen.py
100644 → 100755
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
#!/usr/bin/env python3

import os
import shutil
from pathlib import Path
Expand Down
18 changes: 11 additions & 7 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
mkdocstrings==0.25.1
mkdocstrings-python==1.10.5
mkdocs-autorefs==0.4.1
mkdocs-material==9.1.14
pymdown-extensions==10.0.1
markdown==3.3.7
black==24.4.2
astunparse==1.6.3
griffe==1.2.0
markdown==3.7
markupsafe==2.1.5
mkdocs==1.6.1
mkdocs-autorefs==1.1.0
mkdocs-get-deps==0.2.0
mkdocs-material==9.5.34
mkdocstrings==0.25.2
mkdocstrings-python==1.10.9
pymdown-extensions==10.9

0 comments on commit 9da040b

Please sign in to comment.