diff --git a/.github/workflows/static.yml b/.github/workflows/static.yml new file mode 100644 index 000000000..d4c349459 --- /dev/null +++ b/.github/workflows/static.yml @@ -0,0 +1,54 @@ +# Simple workflow for deploying static content to GitHub Pages +name: Deploy NoiseModelling documentation as a static website + +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: read + pages: write + id-token: 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 + + +env: + MAIN_BRANCH: ${{ github.ref == 'refs/heads/main' }} + +jobs: + # Single deploy job since we're just deploying + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + - uses: actions/setup-python@v5 + - name: Install dependencies + run: | + pip install -r Docs/requirements.txt + - name: Sphinx build + run: | + sphinx-build -M html Docs/ Docs/build + - name: Setup Pages + uses: actions/configure-pages@v4 + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + with: + # Upload static site pages + path: 'Docs/build/html' + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 diff --git a/.readthedocs.yaml b/.readthedocs.yaml index e475a02fe..7ea524c8b 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -16,6 +16,5 @@ formats: python: install: - requirements: Docs/requirements.txt - - method: pip - path: . +