Skip to content

Commit 68fdd30

Browse files
authored
Fix docs workflow (#420)
* Enforce minimal mkdocs version * [Docs] Bump python version to 3.11 * [Docs] Fix python call * [Docs] Limit markdown version to 8.4 * Update build_docs.yml * Update build_docs.yml * Create docs/requirements.txt * Update build_docs.yml * Update build_docs test.yml * Update build_docs.yml * Update build_docs.yml * Update build_docs test.yml * Update requirements.txt * Update requirements.txt * [Docs] Move mkdocs yaml into docs folder * Update build_docs.yml * Update build_docs test.yml * Update mkdocs.yml * [Docs] Add content subfolder
1 parent 587bded commit 68fdd30

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+15
-7
lines changed

.github/workflows/build_docs test.yml

+3-3
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,11 @@ jobs:
2727
cache: "pip"
2828

2929
- name: Install Dependencies
30-
run: pip install markdown mkdocs mkdocs-material mkdocstrings mkdocs-autorefs lightgallery mkdocstrings-python
30+
run: pip install -r ./CAD_Sketcher/docs/requirements.txt
3131

3232
- name: Set Pythonpath
3333
run: echo "PYTHONPATH=$PYTHONPATH:$GITHUB_WORKSPACE/blender-git/blender/release/scripts/modules:$GITHUB_WORKSPACE" >> $GITHUB_ENV
3434

3535
- name: Build
36-
run: python3.10 -m mkdocs build -f ./mkdocs.yml
37-
working-directory: ./CAD_Sketcher
36+
run: python3.10 -m mkdocs build -f ./docs/mkdocs.yml
37+
working-directory: ./CAD_Sketcher

.github/workflows/build_docs.yml

+4-4
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,15 @@ jobs:
2424
- name: Install Python
2525
uses: actions/setup-python@v4
2626
with:
27-
python-version: '3.10'
27+
python-version: '3.11'
2828
cache: "pip"
2929

3030
- name: Install Dependencies
31-
run: pip install markdown mkdocs mkdocs-material mkdocstrings mkdocs-autorefs lightgallery mkdocstrings-python
31+
run: pip install -r ./CAD_Sketcher/docs/requirements.txt
3232

3333
- name: Set Pythonpath
3434
run: echo "PYTHONPATH=$PYTHONPATH:$GITHUB_WORKSPACE/blender-git/blender/release/scripts/modules:$GITHUB_WORKSPACE" >> $GITHUB_ENV
3535

3636
- name: Deploy
37-
run: python3.10 -m mkdocs gh-deploy -f ./mkdocs.yml --force
38-
working-directory: ./CAD_Sketcher
37+
run: python3.11 -m mkdocs gh-deploy -f ./docs/mkdocs.yml --force
38+
working-directory: ./CAD_Sketcher
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

mkdocs.yml docs/mkdocs.yml

+1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
site_name: CAD Sketcher
2+
docs_dir: content
23

34
theme:
45
name: material

docs/requirements.txt

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
mkdocs
2+
markdown <= 3.3.7
3+
mkdocs-material
4+
mkdocstrings
5+
mkdocs-autorefs
6+
lightgallery
7+
mkdocstrings-python

0 commit comments

Comments
 (0)