Skip to content
documentation

Cache dependencies and build docs only for main branch #9

Sign in to view logs

Cache dependencies and build docs only for main branch

Cache dependencies and build docs only for main branch #9

Workflow file for this run

.github/workflows/documentation.yml at 178db1e
name: documentation
on: [push, pull_request, workflow_dispatch]
permissions:
contents: write
jobs:
docs:
runs-on: ubuntu-latest
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0
- uses: actions/setup-python@v3
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r src/requirements/dev.txt
pip install .
pip install -r src/requirements/docs.txt
- name: Sphinx build
run: |
sphinx-apidoc --implicit-namespaces -fo docs/biodm/ src/biodm -H "API Reference"
python3 -m sphinx -b html docs/ _build/
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
# if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: _build/
force_orphan: true