Codacy code coverage reporting #961
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: documentation | |
on: | |
push: | |
branches: [ devel ] | |
pull_request: | |
branches: [ devel ] | |
permissions: | |
contents: read | |
pages: write | |
id-token: write | |
jobs: | |
build_docs: | |
runs-on: ubuntu-latest | |
env: | |
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN}} | |
steps: | |
- name: Checkout | |
uses: actions/checkout@v4 | |
- name: Set up Python | |
uses: actions/setup-python@v5 | |
with: | |
python-version: 3.9 | |
- name: Install non-Python dependencies on Ubuntu | |
run: | | |
sudo apt update | |
sudo apt install graphviz | |
- name: Install Python dependencies | |
run: | | |
python -m pip install -r docs_requirements.txt | |
- name: Make the sphinx doc | |
run: | | |
rm -rf docs/source/modules/STUBDIR | |
make -C docs clean | |
make -C docs html | |
python docs/update_links.py | |
- name: Setup Pages | |
uses: actions/configure-pages@v5 | |
- name: Upload artifact | |
uses: actions/upload-pages-artifact@v3 | |
with: | |
path: 'docs/build/html' | |
deploy_docs: | |
if: github.event_name != 'pull_request' | |
needs: build_docs | |
runs-on: ubuntu-latest | |
environment: | |
name: github-pages | |
url: ${{ steps.deployment.outputs.page_url }} | |
steps: | |
- name: Deploy to GitHub Pages | |
id: deployment | |
uses: actions/deploy-pages@v4 |