Skip to content

Commit 523f27c

Browse files
Merge pull request #76 from amd/alex_doc_update2
Doc generation fix
2 parents cb7c2f3 + 716c30b commit 523f27c

File tree

2 files changed

+13
-10
lines changed

2 files changed

+13
-10
lines changed

.github/workflows/update-plugin-docs.yml

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ permissions:
77

88
on:
99
workflow_dispatch:
10+
schedule:
11+
- cron: '0 0 * * *'
1012

1113
jobs:
1214
generate_docs:
@@ -20,24 +22,25 @@ jobs:
2022
with:
2123
token: ${{ secrets.GITHUB_TOKEN }}
2224

23-
- name: Set up Python
24-
uses: actions/setup-python@v5
25-
with:
26-
python-version: '3.9'
27-
2825
- name: Install dependencies
2926
run: ./dev-setup.sh
3027

3128
- name: Run plugin documentation generator
3229
run: |
30+
source venv/bin/activate
3331
python docs/generate_plugin_doc_bundle.py \
3432
--package nodescraper.plugins.inband \
3533
--output docs/PLUGIN_DOC.md
3634
35+
- name: Format documentation with pre-commit
36+
run: |
37+
source venv/bin/activate
38+
pre-commit run --files docs/PLUGIN_DOC.md || true
39+
3740
- name: Commit and push changes
3841
run: |
39-
git config --global user.name "github-actions[bot]"
40-
git config --global user.email "github-actions[bot]@users.noreply.github.com"
42+
git config user.name "github-actions[bot]"
43+
git config user.email "github-actions[bot]@users.noreply.github.com"
4144
git add docs/PLUGIN_DOC.md
42-
git diff --staged --quiet || git commit -m "docs: Update plugin documentation [automated]"
45+
git diff --staged --quiet || git commit --no-verify -m "docs: Update plugin documentation [automated]"
4346
git push

docs/PLUGIN_DOC.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -823,8 +823,8 @@ class for collection of PCIe data.
823823

824824
### Model annotations and fields
825825

826-
- **pcie_cfg_space**: `typing.Dict[typing.Annotated[str, AfterValidator(func=<function validate_bdf at 0x7f07358a9bd0>)], nodescraper.plugins.inband.pcie.pcie_data.PcieCfgSpace]`
827-
- **vf_pcie_cfg_space**: `typing.Optional[typing.Dict[typing.Annotated[str, AfterValidator(func=<function validate_bdf at 0x7f07358a9bd0>)], nodescraper.plugins.inband.pcie.pcie_data.PcieCfgSpace]]`
826+
- **pcie_cfg_space**: `typing.Dict[typing.Annotated[str, AfterValidator(func=<function validate_bdf at 0x7fea84be9430>)], nodescraper.plugins.inband.pcie.pcie_data.PcieCfgSpace]`
827+
- **vf_pcie_cfg_space**: `typing.Optional[typing.Dict[typing.Annotated[str, AfterValidator(func=<function validate_bdf at 0x7fea84be9430>)], nodescraper.plugins.inband.pcie.pcie_data.PcieCfgSpace]]`
828828

829829
## ProcessDataModel Model
830830

0 commit comments

Comments
 (0)