From a48184fb69c3253d07c30022d6fa1617ad41b188 Mon Sep 17 00:00:00 2001 From: Quentin Date: Wed, 13 Nov 2024 17:05:18 +0100 Subject: [PATCH] adding workflows for docs --- .github/workflows/sphinx.yml | 28 ++++++++++++++++++++++++++++ docs/requirements.txt | 8 ++++++++ 2 files changed, 36 insertions(+) create mode 100644 .github/workflows/sphinx.yml create mode 100644 docs/requirements.txt diff --git a/.github/workflows/sphinx.yml b/.github/workflows/sphinx.yml new file mode 100644 index 0000000..3426748 --- /dev/null +++ b/.github/workflows/sphinx.yml @@ -0,0 +1,28 @@ +name: "Sphinx: Render docs" + +on: + push: + branches: + - main + - docs + +jobs: + 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 \ No newline at end of file diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..b52f56d --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,8 @@ +sphinx>=8.1.3 +sphinx_gallery>=0.18.0 +sphinx-copybutton>=0.5.2 +pydata-sphinx-theme>=0.15.3 +sphinxcontrib-email>=0.3.6 +sphinx-remove-toctrees>=1.0.0 +sphinx-prompt>=1.9.0 +sphinx_design>=0.6.1 \ No newline at end of file