Posible fix to docs generation in github pages 22 #49
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: | |
| 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@v4 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.8' # Use the Python version compatible with your project | |
| - name: Install Nox | |
| run: python -m pip install nox | |
| - name: Run Nox to build docs | |
| run: nox -s docs | |
| - name: Upload documentation artifact | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: site-artifact | |
| path: ./docs/ | |
| build: | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: write | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Build HTML | |
| uses: ammaraskar/sphinx-action@master | |
| - name: Upload artifacts | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: html-docs | |
| path: docs/_build/html/ | |
| - name: Deploy | |
| uses: peaceiris/actions-gh-pages@v3 | |
| if: github.ref == 'refs/heads/main' | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: docs/build/html | |
| # deploy: | |
| # needs: docs | |
| # runs-on: ubuntu-latest | |
| # permissions: | |
| # contents: read | |
| # pages: write | |
| # id-token: write | |
| # actions: read | |
| # steps: | |
| # - name: Checkout Repository | |
| # uses: actions/checkout@v4 | |
| # - name: Download documentation artifact | |
| # uses: actions/download-artifact@v4 | |
| # with: | |
| # name: site-artifact | |
| # path: docs | |
| # - name: Deploy to GitHub Pages | |
| # uses: actions/deploy-pages@v3 |