Posible fix to docs generation in github pages 14 #42
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: Auto Testing | |
| on: | |
| pull_request: | |
| push: | |
| branches: ["master"] | |
| workflow_dispatch: | |
| permissions: | |
| contents: write | |
| pages: write | |
| id-token: write | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| jobs: | |
| tests: | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Install dependencies | |
| run: | |
| pip install .[tests] | |
| - name: Run Unit Tests with Coverage | |
| run: | | |
| coverage run -m pytest -vv | |
| coverage report -m | |
| coverage html | |
| - name: Upload Coverage HTML report to Artifacts | |
| uses: actions/upload-artifact@v4 | |
| if: always() | |
| with: | |
| name: coverage-report-${{matrix.python-version}} | |
| path: htmlcov/ | |
| docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: actions/setup-python@v3 | |
| - name: Install dependencies | |
| run: | | |
| pip install sphinx sphinx_rtd_theme myst_parser | |
| - name: Sphinx build | |
| run: | | |
| sphinx-build doc _build | |
| - name: Deploy to GitHub Pages | |
| uses: peaceiris/actions-gh-pages@v3 | |
| if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }} | |
| with: | |
| publish_branch: gh-pages | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: _build/ | |
| force_orphan: true | |
| # docs: | |
| # runs-on: ubuntu-latest | |
| # steps: | |
| # - uses: actions/checkout@v4 | |
| # - name: Setup Pages | |
| # id: pages | |
| # uses: actions/configure-pages@v2 | |
| # - name: Install Nox | |
| # run: python -m pip install nox | |
| # - name: Run Nox | |
| # run: nox -s docs | |
| # - name: Upload documentation artifact | |
| # uses: actions/upload-artifact@v4 | |
| # with: | |
| # name: site-artifact | |
| # path: ./docs/_build | |
| # deploy: | |
| # needs: | |
| # - docs | |
| # environment: | |
| # name: github-pages | |
| # url: ${{ steps.deployment.outputs.page_url }} | |
| # runs-on: ubuntu-latest | |
| # steps: | |
| # - name: Download artifact | |
| # uses: actions/download-artifact@v4 | |
| # with: | |
| # name: site-artifact | |
| # - name: Configure Pages | |
| # uses: actions/configure-pages@v4 | |
| # - name: Deploy to GitHub Pages | |
| # id: deployment | |
| # uses: actions/deploy-pages@v4 |