-
Notifications
You must be signed in to change notification settings - Fork 0
42 lines (36 loc) · 982 Bytes
/
docs.yml
File metadata and controls
42 lines (36 loc) · 982 Bytes
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
39
40
41
42
# .github/workflows/docs.yml
name: Build Documentation
on:
push:
branches: [main]
paths:
- 'docs/**'
- 'src/**'
- '**.py'
jobs:
BuildDocs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: '3.12'
- name: Install dependencies
run: |
pip install sphinx sphinx-rtd-theme
# Use pyTooling's Sphinx workflow
- name: Build Sphinx Documentation
uses: pyTooling/Actions/.github/workflows/SphinxDocumentation.yml@r6
with:
docs_dir: ./docs
build_dir: ./docs/_build
html_output: true
latex_output: true
PublishDocs:
needs: BuildDocs
uses: pyTooling/Actions/.github/workflows/PublishToGitHubPages.yml@r6
with:
pages_dir: ./docs/_build/html
secrets:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}