Skip to content

Docs Building

Docs Building #50

Workflow file for this run

# This is a basic workflow to help you get started with Actions
name: Docs Building
# Controls when the workflow will run
on:
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# 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:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@master
with:
fetch-depth: 0
- name: Set up Python
uses: actions/setup-python@v2
with:
python-version: 3.9
- name: Install dependencies
run: |
pip install --upgrade pip
python -m pip install -U sphinx
python -m pip install -U sphinx-rtd-theme
- name: Install PySoftK
run: |
pip install .
- name: Sphinx apidocs
shell: bash
run: |
cd docs
sphinx-apidoc -o ./source ../pysoftk
make html
cd ..
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
publish_branch: gh-pages
github_token: ${{ secrets.PYSOFTK_DOCS }}
publish_dir: ./docs/build/html