2021-06-21 05:40:58 +00:00
|
|
|
name: docs
|
|
|
|
on:
|
|
|
|
workflow_dispatch:
|
|
|
|
push:
|
|
|
|
branches:
|
|
|
|
- master
|
|
|
|
paths:
|
2021-10-10 22:16:21 +00:00
|
|
|
- "docs/**"
|
|
|
|
- ".github/workflows/docs.yml"
|
2021-06-24 03:34:39 +00:00
|
|
|
|
|
|
|
env:
|
|
|
|
# Assign commit authorship to official Github Actions bot when pushing to the `gh-pages` branch:
|
2021-10-10 22:16:21 +00:00
|
|
|
GIT_USER: "github-actions[bot]"
|
|
|
|
GIT_EMAIL: "41898282+github-actions[bot]@users.noreply.github.com"
|
2021-06-24 03:34:39 +00:00
|
|
|
|
2021-06-21 05:40:58 +00:00
|
|
|
jobs:
|
|
|
|
build-documentation:
|
|
|
|
name: Build and deploy docs
|
|
|
|
runs-on: ubuntu-latest
|
|
|
|
steps:
|
|
|
|
- uses: actions/checkout@v2
|
2021-06-24 03:34:39 +00:00
|
|
|
with:
|
|
|
|
fetch-depth: 0
|
|
|
|
|
2021-06-21 05:40:58 +00:00
|
|
|
- uses: actions/setup-python@v2
|
|
|
|
with:
|
|
|
|
python-version: 3.x
|
2021-06-24 03:34:39 +00:00
|
|
|
|
2021-10-10 22:16:21 +00:00
|
|
|
- name: Install Python dependencies
|
2021-10-10 22:17:20 +00:00
|
|
|
run: pip install -r docs/requirements.txt
|
2021-06-24 03:34:39 +00:00
|
|
|
|
|
|
|
- name: Configure git user and email
|
|
|
|
run: |
|
|
|
|
git config --global user.name ${GIT_USER}
|
|
|
|
git config --global user.email ${GIT_EMAIL}
|
|
|
|
echo Name: $(git config --get user.name)
|
|
|
|
echo Email: $(git config --get user.email)
|
|
|
|
|
|
|
|
- name: Build and deploy docs with mike
|
|
|
|
run: |
|
|
|
|
cd docs
|
|
|
|
mike deploy nightly --push
|
2021-12-21 02:23:04 +00:00
|
|
|
# - name: Deploy to CF Pages
|
|
|
|
# run: |
|
2022-01-16 21:05:20 +00:00
|
|
|
# curl -X POST ${{ secrets.BOTTOM_CFP_HOOK }}
|