Skip to content

Update README.rst

Update README.rst #73

Workflow file for this run

name: Documentation
on:
push:
branches: [main, master]
jobs:
make-pages:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
ref: ${{ github.event.pull_request.head.ref }}
fetch-depth: 0
fetch-tags: true
- name: select python version
uses: actions/setup-python@v4
with:
python-version: 3.9
- name: install dependencies
run: |
python -m pip install --upgrade pip
python -m pip install .
python -m pip install sphinx
python -m pip install sphinx_rtd_theme
python -m pip install sphinx-click
- name: build documentation
run: |
cd docs
make html
- name: deploy
uses: peaceiris/actions-gh-pages@v3.6.1
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/_build/html
force_orphan: true
full_commit_message: ${{ github.event.head_commit.message }}