Skip to content

New version

New version #126

Workflow file for this run

# On a new commit: push new docs to huracan-docs.github.io
name: Deploy docs
on:
push:
branches: [ master ]
pull_request:
branches: [ master ]
jobs:
Deploy:
runs-on: ubuntu-latest
environment: huracan-docs
steps:
- uses: actions/checkout@v2
- name: Set up Python 3.8
uses: actions/setup-python@v2
with:
python-version: 3.8
- name: Install dependencies
run: |
python -m pip install --upgrade pip
if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
- name: Install pdoc3
run: |
pip install pdoc3
- name: Generate docs
run: pdoc --html huracan --force --output-dir=docs
- name: Push new docs to huracan-docs.github.io
uses: cpina/github-action-push-to-another-repository@main
env:
API_TOKEN_GITHUB: ${{ secrets.API_TOKEN_GITHUB }}
with:
source-directory: 'docs/huracan'
destination-github-username: 'huracan-docs'
destination-repository-name: 'huracan-docs.github.io'
user-email: [email protected]
commit-message: See ORIGIN_COMMIT from $GITHUB_REF
target-branch: main