Skip to content

Commit 3d896e9

Browse files
[V4] Documentation scaffold (#110)
* uv init * zensical init * set branch * update git ignore * a few config tweaks * new favicon * edit buttons * inline docs * move files * index * rm dead init * rm old * pass 1 * hand-write * todo * rm duplicate * pass 2 * explicit order * move dep * switch doc target * fix some warnings * bigger admonitions * spell * point at main
1 parent 46bae8a commit 3d896e9

46 files changed

Lines changed: 3083 additions & 580 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: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: Documentation
2+
on:
3+
push:
4+
branches:
5+
- main
6+
7+
permissions:
8+
contents: read
9+
pages: write
10+
id-token: write
11+
12+
jobs:
13+
deploy:
14+
environment:
15+
name: github-pages
16+
url: ${{ steps.deployment.outputs.page_url }}
17+
18+
runs-on: ubuntu-latest
19+
steps:
20+
- uses: actions/configure-pages@v6
21+
- uses: actions/checkout@v6
22+
- uses: actions/setup-python@v6
23+
with:
24+
python-version: 3.x
25+
- run: pip install zensical
26+
- run: zensical build --clean
27+
- uses: actions/upload-pages-artifact@v5
28+
with:
29+
path: build/site
30+
- uses: actions/deploy-pages@v5
31+
id: deployment

.gitignore

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,6 @@
44
.cache/
55

66
build/
7-
_build/
8-
cmake-build-*/
9-
prefix/
10-
old/
11-
Testing/
12-
13-
docs/index.rst
14-
15-
bench/data/
16-
*.svg
17-
18-
mem.log
19-
memory.csv
20-
memory.*.csv
21-
test.pdf
22-
gmon.out
23-
out.png
24-
output.png
257

268
**/.DS_Store
279

-3.51 KB
Binary file not shown.
-7.25 KB
Binary file not shown.
-3.12 KB
Binary file not shown.
-385 Bytes
Binary file not shown.
-657 Bytes
Binary file not shown.

.legacy/docs/_static/favicon.ico

-15 KB
Binary file not shown.

.python-version

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

docs/api.md

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

0 commit comments

Comments
 (0)