update readme with additional installation notes (#119) #44
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
--- | |
# referenced from Tomás Farías Santana via | |
# https://tomasfarias.dev/posts/sphinx-docs-with-poetry-and-github-pages/ | |
name: publish docs | |
on: | |
push: | |
branches: | |
- main | |
jobs: | |
build: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout | |
uses: actions/checkout@v4 | |
with: | |
fetch-depth: 0 | |
- uses: actions/setup-python@v4 | |
with: | |
python-version: "3.10" | |
- name: install poetry | |
uses: abatilo/actions-poetry@v2 | |
with: | |
poetry-version: "1.6.1" | |
- name: poetry deps | |
run: poetry install | |
- name: Build documentation | |
run: | | |
mkdir pages | |
touch pages/.nojekyll | |
cd docs | |
poetry run sphinx-build -b html source _build | |
cp -r _build/* ../pages/ | |
- name: Deploy documentation | |
uses: JamesIves/github-pages-deploy-action@v4 | |
with: | |
branch: pages | |
folder: pages |