Skip to content

Commit 74f294f

Browse files
committed
Init docs
1 parent ab778f1 commit 74f294f

File tree

2 files changed

+31
-0
lines changed

2 files changed

+31
-0
lines changed

.github/workflows/gh-pages.yml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: Publish Github Pages
2+
3+
on:
4+
push:
5+
branches: [main]
6+
7+
concurrency:
8+
group: gh-${{ github.ref }}
9+
cancel-in-progress: true
10+
11+
jobs:
12+
pages:
13+
runs-on: ubuntu-latest
14+
environment:
15+
name: github-pages
16+
url: ${{ steps.deployment.outputs.page_url }}
17+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
18+
permissions:
19+
pages: write
20+
id-token: write
21+
steps:
22+
- id: deployment
23+
uses: sphinx-notes/pages@v3
24+
with:
25+
documentation_path: ./docs/source
26+
requirements_path: ./docs/requirements.txt
27+
cache: true
28+
python_version: 3.12

docs/requirements.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
sphinx
2+
sphinx-rtd-theme
3+
myst-parser

0 commit comments

Comments
 (0)