diff --git a/.github/workflows/sphinx_build.yml b/.github/workflows/sphinx_build.yml index e268d7b..f96059c 100644 --- a/.github/workflows/sphinx_build.yml +++ b/.github/workflows/sphinx_build.yml @@ -1,43 +1,40 @@ -name: Docs +name: Build and Deploy Docs -on: +on: push: - branches: - - master - pull_request: branches: - - master + - main + +permissions: write-all jobs: - build: + deploy_docs: runs-on: ubuntu-latest - + steps: - - uses: actions/checkout@v1 - # Standard drop-in approach that should work for most people. - - uses: ammaraskar/sphinx-action@master - with: - docs-folder: "docs/" + - uses: actions/checkout@v3 + with: + fetch-depth: 0 # needed for tag/version + + - uses: actions/setup-python@v4 + with: + python-version: '3.10' + + - name: Install package + shell: bash -l {0} + working-directory: docs + run: | + python -m pip install -r requirements.txt + + - name: Build Documentation + shell: bash -l {0} + working-directory: docs + run: | + cd docs + make html - # Publish built docs to gh-pages branch. - # =============================== - - name: Commit documentation changes - run: | - git clone https://github.com/WelbornGroup/ELECTRIC --branch gh-pages --single-branch gh-pages - cp -r docs/_build/html/* gh-pages/ - cd gh-pages - git config --local user.email "action@github.com" - git config --local user.name "GitHub Action" - git add . - git commit -m "Update documentation" -a || true - # The above command will fail if no changes were present, so we ignore - # that. - # Push if this is a push to master. - - name: Push changes - if: ${{ github.event_name == 'push' }} - uses: ad-m/github-push-action@master - with: - branch: gh-pages - directory: gh-pages - github_token: ${{ secrets.PUSH_DOCS }} - # =============================== \ No newline at end of file + - name: Deploy Documentation + uses: JamesIves/github-pages-deploy-action@v4 + with: + folder: docs/_build/html + branch: gh-pages \ No newline at end of file