-
Notifications
You must be signed in to change notification settings - Fork 7.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
39 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
name: ReadTheDocs CI | ||
|
||
on: | ||
push: | ||
branches: | ||
- master | ||
- release/* | ||
paths: | ||
- 'docs/**' | ||
- '.github/workflows/docs.yml' | ||
pull_request: | ||
paths: | ||
- 'docs/**' | ||
- '.github/workflows/docs.yml' | ||
|
||
jobs: | ||
|
||
build-docs: | ||
name: Build ReadTheDocs | ||
runs-on: ubuntu-latest | ||
defaults: | ||
run: | ||
shell: bash | ||
steps: | ||
- uses: actions/checkout@v2 | ||
with: | ||
submodules: true | ||
- uses: actions/setup-python@v2 | ||
with: | ||
python-version: '3.x' | ||
- name: Build | ||
run: | | ||
sudo apt update | ||
sudo apt install python3-pip python3-setuptools | ||
# GitHub CI installs pip3 and setuptools outside the path. | ||
# Update the path to include them and run. | ||
PATH=/home/runner/.local/bin:$PATH pip3 install --user -r ./docs/requirements.txt | ||
cd ./docs && PATH=/home/runner/.local/bin:$PATH SPHINXOPTS="-W" make html |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters