Skip to content

Commit 4f4b443

Browse files
committed
docs: update mkdocs configuration and improve documentation build process
- Removed unnecessary commands from the documentation update step - Added pymdownx.emoji and updated pymdownx.highlight configurations - Enabled pymdownx.tabbed with alternate style
1 parent b7985de commit 4f4b443

2 files changed

Lines changed: 12 additions & 6 deletions

File tree

.github/workflows/docs.yml

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,9 @@ jobs:
2323
poetry install -v --with docs
2424
- name: Update docs
2525
run: |
26-
python -m pip install mkdocs
27-
python -m pip install -r docs/requirements.txt
28-
29-
cd docs
30-
cp ../README.md index.md
31-
cd ..
26+
# cd docs
27+
# cp ../README.md index.md
28+
# cd ..
3229
mkdocs gh-deploy --clean --force
3330
if: success()
3431

mkdocs.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,13 @@ markdown_extensions:
4444
smart_enable: all
4545
- pymdownx.caret
4646
- pymdownx.details
47+
- pymdownx.emoji:
48+
emoji_generator: !!python/name:materialx.emoji.to_svg
49+
emoji_index: !!python/name:materialx.emoji.twemoji
50+
- pymdownx.highlight:
51+
anchor_linenums: true
52+
line_spans: __span
53+
pygments_lang_class: true
4754
- pymdownx.inlinehilite
4855
- pymdownx.keys
4956
- pymdownx.magiclink:
@@ -58,6 +65,8 @@ markdown_extensions:
5865
- name: mermaid
5966
class: mermaid
6067
format: !!python/name:pymdownx.superfences.fence_code_format
68+
- pymdownx.tabbed:
69+
alternate_style: true
6170
- pymdownx.tasklist:
6271
custom_checkbox: true
6372
- pymdownx.tilde

0 commit comments

Comments
 (0)