Skip to content

Commit a173e0c

Browse files
committed
Create book for docs
1 parent 7aa2b62 commit a173e0c

File tree

19 files changed

+662
-0
lines changed

19 files changed

+662
-0
lines changed

.github/workflows/docs.yml

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Docs
2+
on:
3+
push:
4+
branches:
5+
- master
6+
paths:
7+
- docs/*
8+
pull_request:
9+
paths:
10+
- docs/*
11+
jobs:
12+
pages:
13+
runs-on: ubuntu-22.04
14+
permissions:
15+
pages: write
16+
id-token: write
17+
steps:
18+
- name: git checkout
19+
uses: actions/checkout@v4
20+
- name: Install dependencies
21+
run: pip install sphinx-design sphinxawesome-theme rstfmt
22+
- name: Check formatting
23+
run: rstfmt --check -w 100 docs/source
24+
- name: Publish
25+
if: github.event_name == 'push'
26+
uses: sphinx-notes/pages@v3
27+
with:
28+
checkout: false
29+
documentation_path: docs/source
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
build/

0 commit comments

Comments
 (0)