-
Notifications
You must be signed in to change notification settings - Fork 0
42 lines (33 loc) · 997 Bytes
/
docs.yml
File metadata and controls
42 lines (33 loc) · 997 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
name: Documentation
on:
push:
branches: [ main, master ]
pull_request:
branches: [ main, master ]
workflow_dispatch:
permissions:
contents: read
jobs:
build:
name: Build Documentation
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.11"
cache: 'pip'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -e .
pip install mkdocs mkdocs-material mkdocstrings[python] pymdown-extensions
- name: Build documentation
run: mkdocs build --strict --verbose
- name: Check documentation build
run: |
echo "✓ Documentation built successfully"
echo "Note: Documentation is hosted on ReadTheDocs at https://metdatapy.readthedocs.io/"
ls -la site/