Skip to content

Commit

Permalink
Fix docs workflow (#420)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
hlorus authored Nov 13, 2023
1 parent 587bded commit 68fdd30
Show file tree
Hide file tree
Showing 46 changed files with 15 additions and 7 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/build_docs test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,11 @@ jobs:
cache: "pip"

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

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

- name: Build
run: python3.10 -m mkdocs build -f ./mkdocs.yml
working-directory: ./CAD_Sketcher
run: python3.10 -m mkdocs build -f ./docs/mkdocs.yml
working-directory: ./CAD_Sketcher
8 changes: 4 additions & 4 deletions .github/workflows/build_docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,15 @@ jobs:
- name: Install Python
uses: actions/setup-python@v4
with:
python-version: '3.10'
python-version: '3.11'
cache: "pip"

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

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

- name: Deploy
run: python3.10 -m mkdocs gh-deploy -f ./mkdocs.yml --force
working-directory: ./CAD_Sketcher
run: python3.11 -m mkdocs gh-deploy -f ./docs/mkdocs.yml --force
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
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.
1 change: 1 addition & 0 deletions mkdocs.yml → docs/mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
site_name: CAD Sketcher
docs_dir: content

theme:
name: material
Expand Down
7 changes: 7 additions & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
mkdocs
markdown <= 3.3.7
mkdocs-material
mkdocstrings
mkdocs-autorefs
lightgallery
mkdocstrings-python

0 comments on commit 68fdd30

Please sign in to comment.