-
Notifications
You must be signed in to change notification settings - Fork 0
54 lines (54 loc) · 1.49 KB
/
build_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
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
name: Documentation
on:
push:
branches:
- main
- docs
pull_request:
branches:
- main
- docs
jobs:
build-docs:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v2
- name: Set up Python
uses: actions/setup-python@v2
with:
python-version: '3.12'
- name: Install Miniconda
uses: conda-incubator/setup-miniconda@v2
with:
miniconda-version: "latest"
python-version: '3.12'
channels: conda-forge
channel-priority: true
auto-update-conda: true
auto-activate-base: true
- name: Create and activate conda environment
shell: bash -l {0}
run: |
conda env create -f environment.yml
conda activate desc_smokescreen
- name: Install package with docs extra
shell: bash -l {0}
run: |
conda activate desc_smokescreen
python -m pip install --upgrade pip
python -m pip install .[docs]
- name: Build Sphinx documentation
shell: bash -l {0}
run: |
conda activate desc_smokescreen
cd docs
python -m sphinx -b html source build
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
if: ${{ github.event_name == 'push' && (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/docs') }}
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/build/
force_orphan: true