Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: fix mkdocs-material emoji deprecations #777

Merged
merged 3 commits into from
Oct 21, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 2 additions & 18 deletions .github/workflows/gh-pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -61,15 +61,7 @@ jobs:
key: ${{ github.ref }}
path: .cache
- run: |
pip install mkdocs-material
pip install \
mkdocs-exclude-search \
mkdocs-git-revision-date-localized-plugin \
mkdocs-redirects \
mkdocs-htmlproofer-plugin \
mdx_truly_sane_lists
- run: |
pip install pillow cairosvg
pip install --requirement docs/requirements.txt
sudo apt-get install libcairo2-dev libfreetype6-dev libffi-dev libjpeg-dev libpng-dev libz-dev
- run: mkdocs build --strict --verbose

Expand Down Expand Up @@ -105,14 +97,6 @@ jobs:
key: ${{ github.ref }}
path: .cache
- run: |
pip install mkdocs-material
pip install \
mkdocs-exclude-search \
mkdocs-git-revision-date-localized-plugin \
mkdocs-redirects \
mkdocs-htmlproofer-plugin \
mdx_truly_sane_lists
- run: |
pip install pillow cairosvg
pip install --requirement docs/requirements.txt
sudo apt-get install libcairo2-dev libfreetype6-dev libffi-dev libjpeg-dev libpng-dev libz-dev
- run: mkdocs gh-deploy --strict --verbose --force
9 changes: 6 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -151,12 +151,15 @@ site/
*.ups
*.xdelta

# Always commit some WebStorm configs
!.idea/runConfigurations/*

# Always commit files in the docs/ folder (ignoring extension ignores above)
!docs/*

# Always commit fixtures
!test/fixtures/dats/*
!test/fixtures/dats/*/*
!test/fixtures/patches/*
!test/fixtures/roms/*
!test/fixtures/roms/*/*

# Always commit some WebStorm configs
!.idea/runConfigurations/*
16 changes: 16 additions & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
mkdocs-material

mkdocs-exclude-search
mkdocs-git-revision-date-localized-plugin
mkdocs-htmlproofer-plugin
mkdocs-material[imaging]
mkdocs-redirects
mdx_truly_sane_lists

# Requires:
# macOS:
# brew install cairo
# sudo ln -s /opt/homebrew/Cellar/cairo/*/lib/libcairo.2.dylib /usr/local/lib/
# Linux: sudo apt-get install libcairo2-dev libfreetype6-dev libffi-dev libjpeg-dev libpng-dev libz-dev
pillow
cairosvg
5 changes: 3 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,7 @@ nav:
- license.md
# https://github.com/squidfunk/mkdocs-material/issues/889#issuecomment-582297142: how-to open nav links in new tabs
- Download ↗: https://github.com/emmercm/igir/releases/latest" target="_blank
- Donate ↗: https://github.com/sponsors/emmercm
- Issues ↗: https://github.com/emmercm/igir/issues?q=is%3Aopen+is%3Aissue+label%3Abug" target="_blank
- Discuss ↗: https://github.com/emmercm/igir/discussions" target="_blank

Expand Down Expand Up @@ -143,8 +144,8 @@ markdown_extensions:
# https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/
- attr_list
- 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

extra:
analytics:
Expand Down