-
Notifications
You must be signed in to change notification settings - Fork 3
37 lines (33 loc) · 1.01 KB
/
documentation.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
name: Create Documentation
on:
push:
branches:
- develop
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/setup-python@v2
with:
python-version: 3.12
- uses: actions/checkout@v3
with:
fetch-depth: 0
# Install your package to ensure autodoc works
- name: Install ms_mint package
run: pip install -e .
# Install the required dependencies
- name: Install Dependencies
run: |
python -m pip install --upgrade pip
pip install myst-parser sphinx-rtd-theme
# Build the Sphinx documentation
- name: Build Documentation
run: |
sphinx-build -b html docs/ docs/_build/html -v
# Deploy the built documentation to the gh-pages branch
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/_build/html # Ensure this path matches your build output