Skip to content

Commit 4ca54ec

Browse files
docs: add DVE docs (#58)
* docs: add Zensical autodocs and update docs
1 parent 568a41c commit 4ca54ec

75 files changed

Lines changed: 2891 additions & 1095 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: Publish Documentation
2+
3+
on:
4+
push:
5+
branches: 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+
runs-on: ubuntu-24.04
18+
steps:
19+
- uses: actions/configure-pages@v5
20+
21+
- uses: actions/checkout@v5
22+
23+
- name: Install extra dependencies for a python install
24+
run: |
25+
sudo apt-get update
26+
sudo apt -y install --no-install-recommends liblzma-dev libbz2-dev libreadline-dev
27+
28+
- name: Install asdf cli
29+
uses: asdf-vm/actions/setup@b7bcd026f18772e44fe1026d729e1611cc435d47
30+
31+
- name: Install software through asdf
32+
uses: asdf-vm/actions/install@b7bcd026f18772e44fe1026d729e1611cc435d47
33+
34+
- name: reshim asdf
35+
run: asdf reshim
36+
37+
- name: ensure poetry using desired python version
38+
run: poetry env use $(asdf which python)
39+
40+
- name: install docs requirements
41+
run: |
42+
poetry install --sync --no-interaction --with docs
43+
44+
- run: poetry run zensical build --clean
45+
- uses: actions/upload-pages-artifact@v4
46+
with:
47+
path: site
48+
- uses: actions/deploy-pages@v4
49+
id: deployment

.github/workflows/ci_linting.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,10 @@ jobs:
1717
sudo apt -y install --no-install-recommends liblzma-dev libbz2-dev libreadline-dev
1818
1919
- name: Install asdf cli
20-
uses: asdf-vm/actions/setup@v4
20+
uses: asdf-vm/actions/setup@b7bcd026f18772e44fe1026d729e1611cc435d47
2121

2222
- name: Install software through asdf
23-
uses: asdf-vm/actions/install@v4
23+
uses: asdf-vm/actions/install@b7bcd026f18772e44fe1026d729e1611cc435d47
2424

2525
- name: reshim asdf
2626
run: asdf reshim

.github/workflows/ci_testing.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@ jobs:
2020
sudo apt -y install --no-install-recommends liblzma-dev libbz2-dev libreadline-dev libxml2-utils
2121
2222
- name: Install asdf cli
23-
uses: asdf-vm/actions/setup@v4
23+
uses: asdf-vm/actions/setup@b7bcd026f18772e44fe1026d729e1611cc435d47
2424

2525
- name: Install software through asdf
26-
uses: asdf-vm/actions/install@v4
26+
uses: asdf-vm/actions/install@b7bcd026f18772e44fe1026d729e1611cc435d47
2727

2828
- name: reshim asdf
2929
run: asdf reshim

docs/README.md

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

0 commit comments

Comments
 (0)