-
Notifications
You must be signed in to change notification settings - Fork 3
26 lines (26 loc) · 902 Bytes
/
docs.yml
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
name: Documents
on: [push, pull_request, workflow_dispatch]
permissions:
contents: write
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v3
- name: Install dependencies
run: |
pip install git+https://github.com/msinamsina/pyautomail.git
pip install sphinx sphinx_rtd_theme recommonmark
- name: Sphinx build
run: |
sphinx-apidoc ../pyautomail -o api -H "API Rrf." -Mf --tocfile index --templatedir ./_templates/apidoc -d 2
sphinx-build docs _build
- name: Deploy
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