Skip to content

Update README.rst

Update README.rst #12

Workflow file for this run

# This is a basic workflow to help you get started with Actions
name: Build-sphinx-docs
# Controls when the workflow will run
on:
# Triggers the workflow on push or pull request events but only for the main branch
push:
branches: [main]
pull_request:
branches: [main]
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
permissions:
contents: write
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
# This workflow contains a single job called "build"
build:
# The type of runner that the job will run on
runs-on: ubuntu-latest
# Steps represent a sequence of tasks that will be executed as part of the job
steps:
- name: Checkout
uses: actions/checkout@master
with:
fetch-depth: 0
- uses: actions/setup-python@v4
with:
python-version: 3.9
- uses: abatilo/actions-poetry@v2
- name: install
run: poetry install --extras docs
- name: Build documentation
run: |
cd docs/
poetry run sphinx-build -b html source _build/html
- name: Run ghp-import
run: |
pip install ghp-import
ghp-import -n -p -f docs/_build/html