Skip to content

add docs and fix some bug #35

add docs and fix some bug

add docs and fix some bug #35

Workflow file for this run

name: Docs
on:
push:
branches: [main]
pull_request:
branches: [main]
workflow_dispatch:
permissions:
contents: write
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v3
with:
python-version: '3.9'
- name: Install dependencies
run: |
pip install -r docs/requirements.txt
pip install .
- name: Sphinx build
# fail on warnings
run: |
sphinx-build docs/docs_en _build -W --keep-going
sphinx-build docs/docs_cn _build -W --keep-going
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: _build/
force_orphan: true
if: github.event_name != 'pull_request'