Skip to content

updated docs

updated docs #12

Workflow file for this run

name: Auto-deployment of Documentation
on:
push:
branches: [ master ]
jobs:
build-docs:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
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.
run: pip install poetry
- name: Install dependencies.
run: |
poetry install -E docs
- name: Build documentation.
run: |
mkdir gh-pages
touch gh-pages/.nojekyll
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