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.

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

Add make tutorial to docs CI workflow #3012

Merged
merged 10 commits into from
Dec 29, 2022
Merged
Changes from all commits
Commits
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
36 changes: 35 additions & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,40 @@ jobs:
run: |
make docs
make doctest
tutorials-html:
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I moved the tutorial build to a separate stage to limit the impact on CI time

runs-on: ubuntu-20.04
needs: lint
strategy:
matrix:
python-version: [3.7]
steps:
- uses: actions/checkout@v2
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v2
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
run: |
sudo add-apt-repository -y ppa:ubuntu-toolchain-r/test
sudo apt-get update
sudo apt-get install gcc-8 g++-8 ninja-build graphviz pandoc
python -m pip install --upgrade pip wheel 'setuptools!=58.5.*,<60'
# Keep track of pyro-api master branch
pip install https://github.com/pyro-ppl/pyro-api/archive/master.zip
pip install torch==1.11.0+cpu torchvision==0.12.0+cpu -f https://download.pytorch.org/whl/torch_stable.html
pip install .[test]
pip install -r docs/requirements.txt
# requirements for tutorials (from .[dev])
sudo apt-get install pandoc
pip install nbformat
pip install nbsphinx>=0.3.2
pip install nbstripout
pip install pypandoc
pip install ninja
pip freeze
- name: Build HTML from tutorials
run: |
SPHINXOPTS="-E" make tutorial
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I disabled the -W Sphinx flag that treats warnings as errors in the CI builds of the tutorial web pages because there are a number of unfixed warnings in dev and they appear unstable across sphinx versions.

unit:
runs-on: ubuntu-20.04
needs: docs
Expand Down Expand Up @@ -96,7 +130,7 @@ jobs:
COVERALLS_FLAG_NAME: ${{ matrix.test-name }}
examples:
runs-on: ubuntu-20.04
needs: docs
needs: [docs, tutorials-html]
strategy:
matrix:
python-version: [3.7]
Expand Down