More docstring cleanup and fixes #34
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Docs | |
on: | |
workflow_dispatch: | |
pull_request: | |
push: | |
branches: | |
- main | |
permissions: | |
contents: write | |
jobs: | |
build: | |
runs-on: ubuntu-20.04 | |
steps: | |
- uses: actions/checkout@v4 | |
with: | |
fetch-depth: 0 | |
- name: Deps for system pkgs | |
run: | | |
sudo apt-get -qq update | |
sudo apt-get install -yqq python3-gi python3-gi-cairo gir1.2-gtk-3.0 | |
sudo apt-get install -yqq libgirepository1.0-dev libappindicator3-dev | |
sudo apt-get install -yqq software-properties-common | |
sudo add-apt-repository -y -s ppa:nerdboy/embedded | |
sudo apt-get -qq update | |
sudo apt-get install -yqq timew-report | |
- uses: actions/setup-python@v5 | |
with: | |
python-version: '3.9' | |
- name: Add python requirements | |
run: | | |
python -m pip install --upgrade pip | |
pip install tox | |
- name: Build docs | |
run: | | |
tox -e ldocs,docs | |
- uses: actions/upload-artifact@v4 | |
with: | |
name: ApiDocsHTML | |
path: "docs/_build/html/" | |
- name: set nojekyll for github | |
run: | | |
sudo touch docs/_build/html/.nojekyll | |
- name: Deploy docs to gh-pages | |
if: ${{ github.event_name == 'push' }} | |
uses: JamesIves/github-pages-deploy-action@v4 | |
with: | |
branch: gh-pages | |
folder: docs/_build/html/ | |
single-commit: true |