Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix documentation build #158

Merged
merged 2 commits into from
Aug 31, 2021
Merged

Fix documentation build #158

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
879a178
Update ci.yml
HealthyPear Aug 31, 2021
3859faa
fix target
HealthyPear Aug 31, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 16 additions & 9 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,16 +53,23 @@ jobs:
- uses: actions/checkout@v2
with:
fetch-depth: 0

- uses: ammaraskar/sphinx-action@master

- name: Set up Python
uses: actions/setup-python@v2
with:
docs-folder: "docs/"
pre-build-command: |
apt update --yes && apt install --yes git build-essential pandoc
pip install -U pip setuptools wheel
pip install -e .[docs]
# treat warnings as errors, make sure links are working
build-command: make html SPHINXOPTS="-W --keep-going -n --color -w /tmp/sphinx-log"
python-version: 3.8

- name: Install doc dependencies
run: |
sudo apt update --yes && sudo apt install --yes git build-essential pandoc graphviz
pip install -U pip setuptools wheel
pip install -e .[docs]
git describe --tags
python -c 'import protopipe; print(protopipe.__version__)'

- name: Build docs
run: cd docs && make html SPHINXOPTS="-W --keep-going -n --color -j auto"

- name: Deploy to github pages
# only run on push to master
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }}
Expand Down