Skip to content

Commit 248ccd0

Browse files
committed
Add documentation for building and editing API docs; include .DS_Store files in movie outputs
1 parent d6d1408 commit 248ccd0

File tree

202 files changed

+127
-80528
lines changed

Some content is hidden

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

202 files changed

+127
-80528
lines changed

.github/workflows/docs.yml

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
name: Deploy Documentation
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
branches: [main]
8+
workflow_dispatch:
9+
10+
permissions:
11+
contents: read
12+
pages: write
13+
id-token: write
14+
15+
concurrency:
16+
group: "pages"
17+
cancel-in-progress: false
18+
19+
jobs:
20+
build:
21+
runs-on: ubuntu-latest
22+
steps:
23+
- name: Checkout repository
24+
uses: actions/checkout@v4
25+
26+
- name: Set up Python
27+
uses: actions/setup-python@v5
28+
with:
29+
python-version: "3.12"
30+
31+
- name: Install dependencies
32+
run: |
33+
python -m pip install --upgrade pip
34+
pip install sphinx sphinx-rtd-theme myst-parser
35+
pip install -e .
36+
37+
- name: Build documentation
38+
working-directory: docs
39+
run: |
40+
make html
41+
42+
- name: Upload artifact
43+
uses: actions/upload-pages-artifact@v3
44+
with:
45+
path: docs/API_docs
46+
47+
deploy:
48+
if: github.ref == 'refs/heads/main' && github.event_name != 'pull_request'
49+
environment:
50+
name: github-pages
51+
url: ${{ steps.deployment.outputs.page_url }}
52+
runs-on: ubuntu-latest
53+
needs: build
54+
steps:
55+
- name: Deploy to GitHub Pages
56+
id: deployment
57+
uses: actions/deploy-pages@v4

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,7 @@ instance/
7272
docs/_build/
7373
docs/build/
7474
docs/source/api/
75+
docs/API_docs/
7576

7677
# PyBuilder
7778
.pybuilder/

docs/API_docs/.buildinfo

Lines changed: 0 additions & 4 deletions
This file was deleted.

docs/API_docs/.buildinfo.bak

Lines changed: 0 additions & 4 deletions
This file was deleted.
-48.5 KB
Binary file not shown.
-10.1 KB
Binary file not shown.
-224 KB
Binary file not shown.
-1.03 MB
Binary file not shown.
Binary file not shown.
Binary file not shown.

0 commit comments

Comments
 (0)