diff --git a/.github/workflows/update-docs.yaml b/.github/workflows/update-docs.yaml new file mode 100644 index 0000000000..d63019fa35 --- /dev/null +++ b/.github/workflows/update-docs.yaml @@ -0,0 +1,45 @@ +name: Update Docs and Deploy + +on: + push: + branches: + - master + - main + - ci-docs + +jobs: + update-docs: + name: Generate and Deploy Docs + runs-on: ubuntu-latest + + steps: + # Checkout the repository + - name: Checkout Code + uses: actions/checkout@v3 + + # Set up Python environment + - name: Set up Python + uses: actions/setup-python@v4 + with: + python-version: '3.9' + + # Install dependencies + - name: Install Dependencies + run: | + python -m pip install --upgrade pip + pip install -r requirements.txt + pip install sphinx sphinx_book_theme sphinx_markdown_tables recommonmark nbsphinx sphinx_togglebutton + + # Build the documentation + - name: Build Docs + run: | + cd docs + make clean html + + # Deploy to GitHub Pages + - name: Deploy to GitHub Pages + uses: peaceiris/actions-gh-pages@v3 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: docs/_build/html + destination_dir: docs