Skip to content

Commit

Permalink
Dump the changes after building docs to the logs
Browse files Browse the repository at this point in the history
So that it is possible to update a docs PR using the workflow log
rather than having to install docs deps and build the docs locally.

Building the docs takes too long locally so I am doing it in CI.
  • Loading branch information
pabs3 committed Mar 18, 2023
1 parent cd9920b commit 8148c0d
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 3 deletions.
3 changes: 0 additions & 3 deletions .github/workflows/linters.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,3 @@ jobs:

# - name: Run flake8 linter (documentation)
# run: flake8 --ignore E202,E402,E302,E305,F821 --max-line-length 120 --filename '*.py,*.rst' docs

- name: Check Sphinx Gallery cache
run: python docs/src/check_gallery.py
13 changes: 13 additions & 0 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,19 @@ jobs:
run: |
python setup.py build_ext --inplace
make -C docs/src clean html
git add .
git commit -m 'Import documentation changes'
git format-patch @^
git bundle create fix-links.bundle @^...@
- name: Upload patch/bundle as artifacts
if: always()
uses: actions/upload-artifact@v3
with:
name: fix-links-get-patch
path: |
*.patch
*.bundle
#
# FIXME: do we want to store the built documentation somewhere, or is
# knowing that the docs built successfully enough?
Expand Down

0 comments on commit 8148c0d

Please sign in to comment.