Skip to content

Commit

Permalink
Update docs dependencies (#62)
Browse files Browse the repository at this point in the history
  • Loading branch information
ofek authored Dec 31, 2023
1 parent c353a56 commit 9a6568e
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 11 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,5 @@ Cargo.lock
/target

# Documentation
/.cache/
/site/
21 changes: 12 additions & 9 deletions hatch.toml
Original file line number Diff line number Diff line change
@@ -1,22 +1,25 @@
[envs.docs]
detached = true
dependencies = [
"mkdocs~=1.4.0",
"mkdocs-material~=9.1.16",
"mkdocs~=1.5.3",
"mkdocs-material~=9.5.1",
# Plugins
"mkdocs-minify-plugin~=0.6.4",
"mkdocs-git-revision-date-localized-plugin~=1.2.0",
"mkdocs-glightbox~=0.3.4",
# https://github.com/jimporter/mike/issues/82#issuecomment-1172913929
"mike @ https://github.com/jimporter/mike/archive/392d57b8bb9d14bcedf2451a0dc302709f8055eb.zip",
"mkdocs-minify-plugin~=0.7.1",
"mkdocs-git-revision-date-localized-plugin~=1.2.1",
"mkdocs-glightbox~=0.3.5",
"mike~=2.0.0",
# Extensions
"pymdown-extensions~=10.0.1",
"pymdown-extensions~=10.5.0",
# Necessary for syntax highlighting in code blocks
"pygments~=2.15.1",
"pygments~=2.17.2",
# Validation
# https://github.com/linkchecker/linkchecker/pull/669#issuecomment-1267236287
"linkchecker @ git+https://github.com/linkchecker/linkchecker.git@d9265bb71c2054bf57b8c5734a4825d62505c779",
]
[envs.docs.overrides]
env.GITHUB_ACTIONS.env-vars = [
{ key = "MKDOCS_IMAGE_PROCESSING", value = "true", if = ["true"] },
]
[envs.docs.env-vars]
SOURCE_DATE_EPOCH = "1580601600"
PYTHONUNBUFFERED = "1"
Expand Down
12 changes: 10 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@ theme:
features:
- content.action.edit
- content.code.copy
- content.tabs.link
- content.tooltips
- navigation.expand
- navigation.footer
- navigation.instant
Expand All @@ -61,13 +63,16 @@ plugins:
git-revision-date-localized:
strict: false
type: date
# social:
# enabled: !ENV [MKDOCS_IMAGE_PROCESSING, false]

markdown_extensions:
# Built-in
- markdown.extensions.abbr:
- markdown.extensions.admonition:
- markdown.extensions.attr_list:
- markdown.extensions.footnotes:
- markdown.extensions.md_in_html:
- markdown.extensions.meta:
- markdown.extensions.tables:
- markdown.extensions.toc:
Expand All @@ -82,8 +87,8 @@ markdown_extensions:
- pymdownx.emoji:
# https://github.com/twitter/twemoji
# https://raw.githubusercontent.com/facelessuser/pymdown-extensions/master/pymdownx/twemoji_db.py
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.highlight:
guess_lang: false
linenums_style: pymdownx-inline
Expand Down Expand Up @@ -117,6 +122,9 @@ markdown_extensions:
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
slugify: !!python/object/apply:pymdownx.slugs.slugify
kwds:
case: lower
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde:
Expand Down

0 comments on commit 9a6568e

Please sign in to comment.