Skip to content

updated changelog

updated changelog #22

Workflow file for this run

# From https://github.com/eeholmes/readthedoc-test/blob/main/.github/workflows/docs_pages.yml
name: docs_pages_workflow
on:
push:
branches: [ master ]
workflow_dispatch:
jobs:
tests:
uses: ./.github/workflows/unittests.yml
publish_docs:
name: publish_docs
needs: [tests] # require tests to pass before deploy runs
runs-on: ubuntu-latest
steps:
- name: Checkout main
uses: actions/checkout@v3
with:
path: master
- name: Checkout gh-pages
uses: actions/checkout@v3
with:
path: gh-pages
ref: gh-pages
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: 3.9
- name: Install dependencies
run: |
cd ./master
python -m pip install .[dev]
- name: Make the Sphinx docs
run: |
cd ./master/docs
make clean
make github
- name: Commit changes to docs
run: |
cd ./gh-pages
cp -R ../master/docs/_build/html/* ./
cp ../master/docs/_build/html/.nojekyll ./.nojekyll
cp ../master/docs/_build/html/.buildinfo ./.buildinfo
git config --local user.email ""
git config --local user.name "github-actions"
git add -A
if ! git diff-index --quiet HEAD; then
git commit -m "auto: Rebuild docs."
git push
else
echo No commit made because the docs have not changed.
fi