Skip to content
This repository has been archived by the owner on Apr 3, 2024. It is now read-only.
Publish API Docs

Note archived state. #37

Sign in to view logs

Note archived state.

Note archived state. #37

Workflow file for this run

.github/workflows/docs.yml at 2ebbe08
name: Publish API Docs
on:
push:
branches: [ master ]
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- name: Set up Python 3.8
uses: actions/setup-python@v2
with:
python-version: 3.8
- name: Install package
run: |
python -m pip install --upgrade pip setuptools wheel
python -m pip install .[dev]
python -m pip install docutils pydoctor
pydoctor --version
- name: Generate API documentation with pydoctor
run: |
# Run pydoctor build
tox -e docs -- $(git rev-parse HEAD)
- name: Publish API documentation to the gh-pages branch
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./apidocs
commit_message: "Generate API documentation"