Docs #4
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
| # Sample workflow for building and deploying a Jekyll site to GitHub Pages | |
| name: Docs | |
| on: | |
| # Runs on pushes targeting the default branch | |
| push: | |
| branches: ["main"] | |
| # Allows you to run this workflow manually from the Actions tab | |
| workflow_dispatch: | |
| # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
| permissions: | |
| contents: write | |
| pages: write | |
| # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. | |
| # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. | |
| concurrency: | |
| group: "pages" | |
| cancel-in-progress: false | |
| jobs: | |
| # Build job | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v3 | |
| - name: Requirements | |
| run: sudo apt-get install -y python3-sphinx | |
| && pip3 install sphinx-rtd-theme | |
| && pip3 install breathe | |
| && pip3 install sphinx-sitemap | |
| - name: Build | |
| run: | | |
| cd docs | |
| make clean | |
| rm source/code/* | |
| sphinx-apidoc -o source/code/ ../PQAnalysis | |
| make html | |
| cd build/html | |
| touch .nojekyll | |
| # Deployment job | |
| - name: deploy | |
| uses: JamesIves/github-pages-deploy-action@releases/v4 | |
| with: | |
| branch: gh-pages # The branch the action should deploy to. | |
| folder: docs/build/html # The folder the action should deploy. |