Add documentation

This commit is contained in:
Dustin Spicuzza
2020-12-31 01:55:29 -05:00
parent e361d4443a
commit 1392fceeb5
16 changed files with 342 additions and 42 deletions

View File

@@ -10,23 +10,23 @@ jobs:
- uses: actions/checkout@v2
- uses: psf/black@stable
# check-doc:
# runs-on: ubuntu-18.04
check-doc:
runs-on: ubuntu-18.04
# steps:
# - uses: actions/checkout@v2
# with:
# submodules: recursive
# fetch-depth: 0
steps:
- uses: actions/checkout@v2
with:
submodules: recursive
fetch-depth: 0
# - uses: actions/setup-python@v2
# with:
# python-version: 3.8
# - name: Sphinx
# run: |
# pip --disable-pip-version-check install -e .
# pip --disable-pip-version-check install -r docs/requirements.txt
# cd docs && make clean html SPHINXOPTS="-W --keep-going"
- uses: actions/setup-python@v2
with:
python-version: 3.8
- name: Sphinx
run: |
pip --disable-pip-version-check install -e .
pip --disable-pip-version-check install -r docs/requirements.txt
cd docs && make clean html SPHINXOPTS="-W --keep-going"
test:
runs-on: ${{ matrix.os }}
@@ -71,8 +71,7 @@ jobs:
publish:
runs-on: ubuntu-latest
#needs: [check, check-doc, test]
needs: [check, test]
needs: [check, check-doc, test]
if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags')
steps: