docs: Merge pull request #224 from arfon/patch-1 #376
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: Documentation | |
on: | |
push: | |
branches: [main] | |
pull_request: | |
branches: [main] | |
jobs: | |
build: | |
runs-on: ubuntu-latest | |
concurrency: documentation | |
steps: | |
- name: Checkout | |
uses: actions/checkout@v3 | |
with: | |
fetch-depth: 0 # otherwise, you will failed to push refs to dest repo | |
token: ${{ secrets.SPHINX_DOCUMENTATION }} | |
- name: Install dependencies | |
shell: bash | |
run: | | |
python -m pip install --upgrade pip | |
pip install ".[docs,all,tutorials]" | |
pip install -r ./docs/tutorials/requirements.txt | |
- name: Create augmenters table | |
shell: bash | |
run: | | |
python ./docs/create_augmenters_table.py | |
- name: Build and Commit | |
uses: sphinx-notes/[email protected] | |
with: | |
documentation_path: docs | |
sphinx_version: "5.3.0" | |
- name: Push changes | |
if: ${{ github.event_name == 'push' }} | |
uses: ad-m/[email protected] | |
with: | |
github_token: ${{ secrets.SPHINX_DOCUMENTATION }} | |
branch: gh-pages |