diff --git a/.github/workflows/deploy-gh-pages.yaml b/.github/workflows/deploy-gh-pages.yaml new file mode 100644 index 000000000..3ca97d80a --- /dev/null +++ b/.github/workflows/deploy-gh-pages.yaml @@ -0,0 +1,55 @@ +# Sample workflow for building and deploying a Jekyll site to GitHub Pages +name: Deploy GitHub Pages with Sphinx-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: read + pages: write + id-token: write + +# Allow one concurrent deployment +concurrency: + group: pages + cancel-in-progress: true + +jobs: + # Build job + build: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v3 + - name: Setup Pages + uses: actions/configure-pages@v2 + - name: Install Sphinx and plugins + run: | + pipx install sphinx + pipx inject sphinx recommonmark + pipx inject sphinx sphinx_rtd_theme + - name: Build docs with Sphinx-docs + working-directory: docs + run: make html + - name: Upload artifact + uses: actions/upload-pages-artifact@v1 + with: + path: docs/build/ + + # Deployment job + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + needs: build + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v2 diff --git a/.gitignore b/.gitignore index 770de1582..cdc0bac58 100644 --- a/.gitignore +++ b/.gitignore @@ -60,3 +60,7 @@ docker-compose-prod-non-domain.yml docker-compose-prod.yml install-production.sh .gitlab-ci.yml + +# Sphinx documentation +docs/_build/ +docs/build/