Skip to content

Commit

Permalink
Fix mkdocs generation + CI control job (#3135)
Browse files Browse the repository at this point in the history
* Use mkdocs-material emojis extension

* Fix mkdocs-material generation + control job
  • Loading branch information
nvuillam authored Nov 19, 2023
1 parent 7ccf1af commit dbf69d8
Show file tree
Hide file tree
Showing 4 changed files with 33 additions and 5 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/build-deploy-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ jobs:
fetch-depth: 0
- uses: actions/setup-python@v4.5.0
with:
python-version: 3.10.4
python-version: 3.12.0
- run: pip install --upgrade -r .config/python/dev/requirements.txt
- run: cd .automation && bash build_schemas_doc.sh && cd ..
# - run: mkdocs gh-deploy --force
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/deploy-RELEASE.yml
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ jobs:
echo "curr ver ${{ steps.version.outputs.cversion }}"
- uses: actions/setup-python@v4.5.0
with:
python-version: 3.x
python-version: 3.12.0
- run: pip install --upgrade -r .config/python/dev/requirements.txt
- run: cd .automation && bash build_schemas_doc.sh && cd ..
# - run: mkdocs gh-deploy --force
Expand Down
28 changes: 28 additions & 0 deletions .github/workflows/test-mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: "Check MkDocs generation"
on:
push:
paths:
- "**/mkdocs.yml"
pull_request:
paths:
- "**/mkdocs.yml"

concurrency:
group: ${{ github.ref }}-${{ github.workflow }}
cancel-in-progress: true

jobs:

test-doc-gen:
runs-on: ubuntu-latest
permissions: read-all
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v4.5.0
with:
python-version: 3.12.0
- run: pip install --upgrade -r .config/python/dev/requirements.txt
- run: cd .automation && bash build_schemas_doc.sh && cd ..
- run: mkdocs build


6 changes: 3 additions & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,12 @@ plugins:
- search
markdown_extensions:
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.snippets:
base_path: docs
check_paths: true
restrict_base_path: False
restrict_base_path: false
- mdx_truly_sane_lists
- attr_list
extra_javascript:
Expand Down

0 comments on commit dbf69d8

Please sign in to comment.