Doc fixes & more metadata in pyproject for PyPI (#147) #58
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
name: Sphinx Documentation | |
on: | |
push: | |
branches: [ main ] | |
jobs: | |
build-docs: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout | |
uses: actions/checkout@main | |
with: | |
fetch-depth: 0 # otherwise, you will failed to push refs to dest repo | |
- name: Set up Python 3. | |
uses: actions/setup-python@v3 | |
with: | |
python-version: 3.9 | |
- name: Install Poetry. | |
uses: snok/[email protected] | |
- name: install | |
run: poetry install -E docs | |
- name: Build documentation. | |
run: | | |
mkdir gh-pages | |
touch gh-pages/.nojekyll | |
make all-docs | |
cd docs/ | |
poetry run sphinx-build -b html . _build | |
cp -r _build/* ../gh-pages/ | |
- name: Deploy documentation. | |
if: ${{ github.event_name == 'push' }} | |
uses: JamesIves/[email protected] | |
with: | |
branch: gh-pages | |
force: true | |
folder: gh-pages |