Skip to content

Commit 9d4cf55

Browse files
author
Obada Haddad
committed
remove some mkdocs traces, update workflow to use zensical instead of mkdocs
1 parent 1bf091e commit 9d4cf55

File tree

4 files changed

+23
-64
lines changed

4 files changed

+23
-64
lines changed

.github/workflows/ghPages-dev.yml

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

.github/workflows/ghPages-prod.yml

Lines changed: 20 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,29 @@
1-
name: github-pages-prod
1+
name: Documentation
22
on:
33
push:
4-
tags:
5-
- '*'
4+
branches:
5+
- master
6+
- main
67
permissions:
7-
contents: write
8+
contents: read
9+
pages: write
10+
id-token: write
811
jobs:
9-
deploy-prod:
12+
deploy:
13+
environment:
14+
name: github-pages
15+
url: ${{ steps.deployment.outputs.page_url }}
1016
runs-on: ubuntu-latest
11-
defaults:
12-
run:
13-
working-directory: documentation/
1417
steps:
15-
- uses: actions/checkout@v4
16-
- name: Configure Git Credentials
17-
run: |
18-
git config user.name github-actions[bot]
19-
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
18+
- uses: actions/configure-pages@v5
19+
- uses: actions/checkout@v5
2020
- uses: actions/setup-python@v5
2121
with:
2222
python-version: 3.x
23-
- run: curl -LsSf https://astral.sh/uv/install.sh | sh
24-
- run: /home/runner/.local/bin/uv sync
25-
- run: git fetch origin gh-pages --depth=1 && PDF=1 /home/runner/.local/bin/uv run mike deploy -u ${{ github.ref_name }} latest --push
23+
- run: pip install zensical
24+
- run: zensical build --clean
25+
- uses: actions/upload-pages-artifact@v4
26+
with:
27+
path: site
28+
- uses: actions/deploy-pages@v4
29+
id: deployment

documentation/README.md

Lines changed: 3 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -14,26 +14,12 @@ To build the docs locally, you will have to first install [uv](https://github.co
1414
Once that is done, you can run the following commands (while inside this folder):
1515

1616
```bash
17-
uv sync # You only need to run this once, it will download all the necessary python packages
18-
PDF=1 uv run mkdocs serve -a localhost:8888 # This will build the site and serve it on localhost:8888
17+
uv sync --frozen # You only need to run this once, it will download all the necessary python packages
18+
uv run zensical serve -a localhost:8888 # This will build the site and serve it on localhost:8888
1919
```
2020

2121
Open [localhost:8888](http://localhost:8888/) in your browser and you will see the docs. Every changes you make will rebuild the documentation.
2222
You can remove the `PDF=1` environement variable if you want to speed up the build process, but you will not generate the related PDF.
2323

24-
25-
### Versioning
26-
We use the [mike](https://github.com/jimporter/mike) plugin to preserve multiple version of the docs.
27-
28-
To use it, you can run the following command:
29-
```bash
30-
PDF=1 uv run mike deploy -u dev # This will create the site and push the changes in the gh-pages branch
31-
uv run mike serve -a localhost:8888 # Serve the site on localhost:8888
32-
```
33-
Check the official Github page of the plugin for more information on how it works.
34-
3524
## Images and Assets
36-
Images and assets are saved in the `_attachments` folder closest to the documentation file that calls for the image. If an image is used in multiple different places, then it should be put in `_attachements` folder in the `docs/` root directory.
37-
38-
## Github workflow
39-
We have Github workflows set up to automatically rebuild the docs when the `develop` branch receives changes, and when a new tag is created for the `master` branch.
25+
Images and assets are saved in the `_attachments` folder closest to the documentation file that calls for the image. If an image is used in multiple different places, then it should be put in `_attachements` folder in the `docs/` root directory.

documentation/main.py

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

0 commit comments

Comments
 (0)