This repository has been archived by the owner on Feb 11, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 26
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* move CI docs CircleCI > GHA * add makefile * update docs conf * fix pillow ver * CI: triggers & skip drafts * CI: drop appveyor
- Loading branch information
Showing
17 changed files
with
164 additions
and
207 deletions.
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
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
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
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
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,83 @@ | ||
name: "Docs check" | ||
# https://github.com/marketplace/actions/sphinx-build | ||
|
||
on: | ||
- pull_request | ||
|
||
jobs: | ||
|
||
test-docs: | ||
runs-on: ubuntu-20.04 | ||
steps: | ||
- uses: actions/checkout@master | ||
- uses: actions/setup-python@v2 | ||
with: | ||
python-version: 3.7 | ||
|
||
# Note: This uses an internal pip API and may not always work | ||
# https://github.com/actions/cache/blob/master/examples.md#multiple-oss-in-a-workflow | ||
- name: Cache pip | ||
uses: actions/cache@v2 | ||
with: | ||
path: ~/.cache/pip | ||
key: ${{ runner.os }}-pip-${{ hashFiles('requirements.txt') }} | ||
restore-keys: | | ||
${{ runner.os }}-pip- | ||
- name: Install dependencies | ||
run: | | ||
sudo apt-get update && sudo apt-get install -y cmake pandoc | ||
pip --version | ||
pip install -r requirements.txt | ||
pip install -r docs/requirements.txt | ||
pip list | ||
shell: bash | ||
|
||
- name: Test Documentation | ||
run: | | ||
# First run the same pipeline as Read-The-Docs | ||
cd docs | ||
make doctest | ||
make-docs: | ||
runs-on: ubuntu-20.04 | ||
steps: | ||
- uses: actions/checkout@master | ||
- uses: actions/setup-python@v2 | ||
with: | ||
python-version: 3.7 | ||
|
||
# Note: This uses an internal pip API and may not always work | ||
# https://github.com/actions/cache/blob/master/examples.md#multiple-oss-in-a-workflow | ||
- name: Cache pip | ||
uses: actions/cache@v2 | ||
with: | ||
path: ~/.cache/pip | ||
key: ${{ runner.os }}-pip-${{ hashFiles('requirements.txt') }} | ||
restore-keys: | | ||
${{ runner.os }}-pip- | ||
- name: Install dependencies | ||
run: | | ||
sudo apt-get update | ||
sudo apt-get install -y cmake pandoc latexmk | ||
sudo apt-get install -y texlive-latex-extra dvipng texlive-pictures | ||
pip --version | ||
pip install -r requirements.txt | ||
pip install -r docs/requirements.txt | ||
pip list | ||
shell: bash | ||
|
||
- name: Make Documentation | ||
run: | | ||
cd docs | ||
make clean | ||
make html --debug --jobs 2 SPHINXOPTS="-W" | ||
make latexpdf | ||
- name: Upload built docs | ||
uses: actions/upload-artifact@v2 | ||
with: | ||
name: docs-results-${{ runner.os }}-${{ matrix.python-version }} | ||
path: docs/build/html/ | ||
if: success() |
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
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,21 @@ | ||
.PHONY: test clean docs | ||
|
||
clean: | ||
# clean all temp runs | ||
rm -rf .pytest_cache | ||
rm -rf ./docs/build | ||
rm -rf ./docs/source/*.md | ||
rm -rf ./docs/source/api | ||
rm -rf ./docs/source/notebooks | ||
|
||
test: clean | ||
pip install --quiet -r requirements.txt | ||
pip install --quiet -r tests/requirements.txt | ||
|
||
# run tests with coverage | ||
python -m coverage run --source birl -m pytest birl tests -v | ||
python -m coverage report | ||
|
||
docs: clean | ||
pip install --quiet -r docs/requirements.txt | ||
python -m sphinx -b html -W --keep-going docs/source docs/build |
This file was deleted.
Oops, something went wrong.
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
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
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
Oops, something went wrong.