Update docs #292
This file contains 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: Publish docs | |
| on: | |
| push: | |
| branches: [ "main" ] | |
| pull_request: | |
| branches: [ "main" ] | |
| workflow_dispatch: | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout lib with submodules | |
| uses: actions/checkout@v3 | |
| with: | |
| submodules: recursive | |
| - name: Set up Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: '3.11' | |
| - name: Install pydoctor | |
| run: | | |
| python -m pip install --upgrade pip setuptools wheel | |
| python -m pip install docutils pydoctor | |
| - name: Generate docs | |
| run: | | |
| pydoctor ./tivars --config ./pyproject.toml \ | |
| --project-url=https://github.com/$GITHUB_REPOSITORY \ | |
| --project-base-dir="$(pwd)" \ | |
| --html-viewsource-base=https://github.com/$GITHUB_REPOSITORY/tree/$GITHUB_SHA \ | |
| --html-output ./docs \ | |
| --make-html | |
| - name: Patch the name index | |
| run: | | |
| cd ./docs | |
| sed -i -r "s:<li>(.*?) 0 - <code data-type=.*?><a href=.(.*?)html#\1%200. class=.internal-link.>\2\1 0</a></code></li>::g" nameIndex.html | |
| - name: Upload pages artifact | |
| uses: actions/upload-pages-artifact@v1 | |
| with: | |
| path: docs/ | |
| deploy: | |
| needs: build | |
| runs-on: ubuntu-latest | |
| permissions: | |
| pages: write | |
| id-token: write | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| steps: | |
| - id: deployment | |
| uses: actions/deploy-pages@v2 |