Skip to content

Commit

Permalink
Undo all recent automated doc build experiments (#480)
Browse files Browse the repository at this point in the history
  • Loading branch information
mdickinson committed Aug 2, 2021
1 parent 34bd9e3 commit cef95e5
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 367 deletions.
25 changes: 17 additions & 8 deletions .github/workflows/build-docs.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
name: Update gh-pages documentation for main and maintenance branches
name: Update gh-pages documentation for main branch

on:
workflow_dispatch:
push:
branches:
- main
- maint/[0-9]+.[0-9]+
- main

env:
PYTHONUNBUFFERED: 1
Expand All @@ -29,10 +27,21 @@ jobs:
run: |
python -m pip install --upgrade pip setuptools wheel
python -m pip install .[docs]
- name: Build HTML documentation with Sphinx
run: |
cd docs
python -m sphinx -b html -d doctrees source build
- name: Configure Git
run: |
git config --global user.name "Documentation Bot"
git config --global user.email "<>"
- name: Build documentation and deploy to gh-pages
git config user.name "Documentation Bot"
git config user.email "<>"
- name: Update gh-pages branch
run: |
python scripts/update_docs.py --token ${{ secrets.GITHUB_TOKEN }} ${{ github.ref }}
git fetch --depth=1 origin gh-pages
git checkout gh-pages
rm -r dev
mv docs/build dev
git add dev
# Only commit if there are changes
git diff-index --quiet --cached HEAD || git commit -m "Automated update of main branch documentation"
git push origin gh-pages
3 changes: 0 additions & 3 deletions docs/source/changes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,6 @@ Continuous integration and build

* Add cron-job-based workflow to validate installation of the latest
wheel and sdist from PyPI. (#465)
* Add new script for automating gh-pages updates, and extend automated
documentation building to the maintenance branches in addition to
the main branch. (#474, #477)


Release 0.3.1
Expand Down

0 comments on commit cef95e5

Please sign in to comment.