Skip to content

Commit 8bd3589

Browse files
committed
add docs
1 parent b879fe0 commit 8bd3589

File tree

164 files changed

+29731
-1
lines changed

Some content is hidden

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

164 files changed

+29731
-1
lines changed

.github/workflows/documentation.yml

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: documentation
2+
3+
on: [push, pull_request, workflow_dispatch]
4+
5+
permissions:
6+
contents: write
7+
8+
jobs:
9+
docs:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/checkout@v4
13+
- uses: actions/setup-python@v5
14+
with:
15+
python-version: '3.10'
16+
- name: Install dependencies
17+
run: |
18+
pip install sphinx sphinx_rtd_theme myst_parser sphinx-autoapi
19+
- name: Sphinx build
20+
run: |
21+
sphinx-build doc _build
22+
- name: Deploy to GitHub Pages
23+
uses: peaceiris/actions-gh-pages@v3
24+
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
25+
with:
26+
publish_branch: gh-pages
27+
github_token: ${{ secrets.GITHUB_TOKEN }}
28+
publish_dir: _build/
29+
force_orphan: true

_build/.buildinfo

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Sphinx build info version 1
2+
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3+
config: fff8da88de1e706dbf4177ce4057c5c0
4+
tags: 645f666f9bcd5a90fca523b33c5a78b7
3.95 KB
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.

0 commit comments

Comments
 (0)