-
Notifications
You must be signed in to change notification settings - Fork 63
38 lines (31 loc) · 1.08 KB
/
auto_generate_docs.yml
File metadata and controls
38 lines (31 loc) · 1.08 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
name: Auto Documentation
on:
release:
types: [published]
jobs:
generate_docs:
if: ${{ github.repository_owner == 'bczsalba' }} # prevents workflow from running in forked repos
runs-on: ubuntu-latest
steps:
- name: Checkout master branch
uses: actions/checkout@v2
- name: Set up Python
uses: actions/setup-python@v2
with:
python-version: "3.x"
- name: Install pdoc & dependencies
run: |
python -m pip install --upgrade pip
pip install pdoc
pip install .
- name: Generate documentation
run: |
pdoc -o ./docs pytermgui --logo https://github.com/bczsalba/pytermgui/blob/master/assets/title.png?raw=true --docformat google
- name: Commit changes
run: |
git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
git config --local user.name "github-actions[bot]"
git add ./docs/
git commit -m "Auto-update documentation"
- name: Push changes
uses: ad-m/github-push-action@master