Skip to content

Commit 3975ffb

Browse files
committed
docs: add sphinx documentation
1 parent 59cb6eb commit 3975ffb

58 files changed

Lines changed: 4404 additions & 0 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/docs.yml

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
name: Publish documentation
2+
3+
on:
4+
push:
5+
branches: [main]
6+
workflow_dispatch:
7+
8+
permissions:
9+
contents: read
10+
pages: write
11+
id-token: write
12+
13+
concurrency:
14+
group: pages
15+
cancel-in-progress: false
16+
17+
jobs:
18+
build:
19+
runs-on: ubuntu-latest
20+
21+
steps:
22+
- name: Check out repository
23+
uses: actions/checkout@v4
24+
25+
- name: Set up Python
26+
uses: actions/setup-python@v5
27+
with:
28+
python-version: "3.11"
29+
30+
- name: Install package and documentation dependencies
31+
run: |
32+
python -m pip install --upgrade pip
33+
python -m pip install -e ".[docs]"
34+
35+
- name: Build documentation
36+
env:
37+
GPMP_LOG_LEVEL: WARNING
38+
MPLCONFIGDIR: /tmp/matplotlib-cache
39+
run: sphinx-build -M html docs/source docs/build -E
40+
41+
- name: Configure GitHub Pages
42+
uses: actions/configure-pages@v5
43+
44+
- name: Upload documentation artifact
45+
uses: actions/upload-pages-artifact@v3
46+
with:
47+
path: docs/build/html
48+
49+
deploy:
50+
needs: build
51+
runs-on: ubuntu-latest
52+
environment:
53+
name: github-pages
54+
url: ${{ steps.deployment.outputs.page_url }}
55+
56+
steps:
57+
- name: Deploy to GitHub Pages
58+
id: deployment
59+
uses: actions/deploy-pages@v4

0 commit comments

Comments
 (0)