Skip to content

update readme part4 #144

update readme part4

update readme part4 #144

Workflow file for this run

name: build sphinx docs
on:
push:
branches:
- main
jobs:
publish_sphinx_docs:
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- name: Checkout code
uses: actions/checkout@v2
- name: Setup Python ${{ matrix.python-version }}
uses: actions/setup-python@v2
with:
python-version: 3.10.9
- name: Install poetry
uses: abatilo/actions-poetry@v2
with:
poetry-version: 1.8.4
- name: Set Poetry config
run: |
poetry config virtualenvs.create false
- name: Install dependencies
run: |
poetry install
- name: Sphinx build
run: |
sphinx-apidoc -o docs src/ src/examples/*.py --separate
sphinx-build docs docs/_build/html
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/_build/html
force_orphan: true