Skip to content

Commit 86e68a9

Browse files
committed
docs: use a virtual env for pip deps [skip ci]
1 parent 26c18b0 commit 86e68a9

File tree

2 files changed

+17
-10
lines changed

2 files changed

+17
-10
lines changed

.github/workflows/docs.yml

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,14 @@ jobs:
2828

2929
- name: Setup pandoc
3030
run: |
31-
wget https://github.com/jgm/pandoc/releases/download/3.1.2/pandoc-3.1.2-1-amd64.deb
32-
sudo dpkg -i pandoc-3.1.2-1-amd64.deb
33-
rm pandoc-3.1.2-1-amd64.deb
31+
wget https://github.com/jgm/pandoc/releases/download/3.5/pandoc-3.5-1-amd64.deb
32+
sudo dpkg -i pandoc-3.5-1-amd64.deb
33+
rm pandoc-3.5-1-amd64.deb
3434
3535
- name: Build Documentation
3636
run: |
37+
python -m venv ./.venv
38+
source ./.venv/bin/activate
3739
task docs
3840
3941
- name: Deploy Documentation

docs/Taskfile.yml

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,26 @@
11
# https://taskfile.dev/#6/installation
22
version: 3
33

4+
# Run before install pip deps
5+
# python -m venv ./.venv
6+
# source ./.venv/bin/activate
7+
48
tasks:
59
readme:
6-
- pip install -q -U pandoc-include
10+
- pipx install pandoc-include
711
# requires pandoc 3.0.0 or higher
812
- pandoc -s --filter pandoc-include -o ../README.md ./README.md
913

1014
docs:
1115
deps:
1216
- readme
1317
cmds:
14-
- pip install -q -U GitPython sphinx-rtd-theme breathe sphinx-sitemap sphinxcontrib-moderncmakedomain myst-parser pandoc-include
15-
- cmake -S ./ -B ./build -G "Ninja Multi-Config" -DCMAKE_BUILD_TYPE=Release
16-
- cmake --build ./build --config Release
17-
- touch ./build/.nojekyll
18-
- rm -rf ./build/*.ninja ./build/*log ./build/*.py ./build/CMakeFiles ./build/CMakeCache.txt ./build/*.cmake
18+
- |
19+
pip install GitPython sphinx-rtd-theme breathe sphinx-sitemap sphinxcontrib-moderncmakedomain myst-parser
20+
cmake -S ./ -B ./build -G "Ninja Multi-Config" -DCMAKE_BUILD_TYPE=Release
21+
cmake --build ./build --config Release
22+
touch ./build/.nojekyll
23+
rm -rf ./build/*.ninja ./build/*log ./build/*.py ./build/CMakeFiles ./build/CMakeCache.txt ./build/*.cmake
1924
2025
docs.preview:
2126
deps:
@@ -27,4 +32,4 @@ tasks:
2732
deps:
2833
- docs
2934
cmds:
30-
- npx gh-pages -d ./build/ -t true
35+
- npx -y gh-pages -d ./build/ -t true

0 commit comments

Comments
 (0)