docs(runtime): clean up #5
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Docs Audit | |
| on: | |
| pull_request: | |
| push: | |
| branches: | |
| - main | |
| - master | |
| workflow_dispatch: | |
| jobs: | |
| docs-audit: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Check out repository | |
| uses: actions/checkout@v4 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.12" | |
| - name: Set up Node.js | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: "20" | |
| - name: Rebuild generated docs artifacts | |
| run: | | |
| python3 runtime/tools/build-indexes.py | |
| python3 runtime/tools/build-llms-txt.py | |
| python3 sage/tools/build-indexes.py | |
| python3 sage/tools/build-llms-txt.py | |
| python3 slg/tools/build-indexes.py | |
| python3 slg/tools/build-llms-txt.py | |
| python3 virtnosis/tools/build-indexes.py | |
| python3 virtnosis/tools/build-llms-txt.py | |
| python3 silk/tools/build-indexes.py | |
| python3 silk/tools/build-llms-txt.py | |
| - name: Run docs audits | |
| run: | | |
| python3 runtime/tools/audit-site.py | |
| python3 sage/tools/audit-site.py | |
| python3 slg/tools/audit-site.py | |
| python3 virtnosis/tools/audit-site.py | |
| python3 silk/tools/audit-site.py | |
| python3 silk/tools/audit-stdlib-docs.py | |
| - name: Run static checks | |
| run: | | |
| python3 -m py_compile runtime/tools/*.py | |
| python3 -m py_compile sage/tools/*.py | |
| python3 -m py_compile slg/tools/*.py | |
| python3 -m py_compile virtnosis/tools/*.py | |
| python3 -m py_compile silk/tools/*.py | |
| node --check assets/docs-viewer.js | |
| node --check assets/spec-viewer.js | |
| node --check assets/site.js | |
| git diff --check | |
| git diff --exit-code -- \ | |
| runtime/docs/index.json \ | |
| runtime/docs/search.json \ | |
| runtime/llms.txt \ | |
| sage/docs/index.json \ | |
| sage/docs/search.json \ | |
| sage/llms.txt \ | |
| slg/docs/index.json \ | |
| slg/docs/search.json \ | |
| slg/llms.txt \ | |
| virtnosis/docs/index.json \ | |
| virtnosis/docs/search.json \ | |
| virtnosis/llms.txt \ | |
| silk/docs/index.json \ | |
| silk/docs/search.json \ | |
| silk/wiki/index.json \ | |
| silk/wiki/search.json \ | |
| silk/llms.txt |