From 9955585d23553135ff23ede4f17050d074b786ff Mon Sep 17 00:00:00 2001 From: subhamkrai Date: Wed, 18 Oct 2023 12:19:52 +0530 Subject: [PATCH] ci: fix mkdocs deprecated imports migrate to using mkdocs-material's material.extensions.emoji.twemoji and material.extensions.emoji.to_svg in place of the respective materialx.emoji.twemoji and materialx.emoji.to_svg. Also, this requires latest version of mkdocs-material. Signed-off-by: subhamkrai (cherry picked from commit b186150e1c6a5d25d91e693623a1a18ed2607529) --- build/release/requirements_docs.txt | 2 +- mkdocs.yml | 29 +++++++++++++++-------------- 2 files changed, 16 insertions(+), 15 deletions(-) diff --git a/build/release/requirements_docs.txt b/build/release/requirements_docs.txt index 6833874eb..56068eba1 100644 --- a/build/release/requirements_docs.txt +++ b/build/release/requirements_docs.txt @@ -3,7 +3,7 @@ mkdocs mkdocs-awesome-pages-plugin mkdocs-exclude mkdocs-macros-plugin -mkdocs-material==8.* +mkdocs-material mkdocs-material-extensions mkdocs-minify-plugin mkdocs-redirects diff --git a/mkdocs.yml b/mkdocs.yml index fe2cbdf71..6b7b20db6 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,6 +1,6 @@ site_name: Rook Ceph Documentation docs_dir: Documentation/ -site_url: 'https://rook.io' +site_url: "https://rook.io" repo_url: https://github.com/rook/rook edit_uri: edit/master/Documentation/ site_author: Rook Authors @@ -26,15 +26,15 @@ theme: favicon: https://rook.io/images/favicon_192x192.png logo: https://rook.io/images/rook-logo.svg palette: - - scheme: 'default' - primary: 'rook-blue' - accent: 'deep orange' + - scheme: "default" + primary: "rook-blue" + accent: "deep orange" toggle: icon: material/toggle-switch-off-outline name: Switch to dark mode - - scheme: 'slate' - primary: 'rook-blue' - accent: 'red' + - scheme: "slate" + primary: "rook-blue" + accent: "red" toggle: icon: material/toggle-switch name: Switch to light mode @@ -75,10 +75,11 @@ plugins: README.md: Getting-Started/intro.md - mike: # these fields are all optional; the defaults are as below... - version_selector: true # set to false to leave out the version selector - css_dir: css # the directory to put the version selector's CSS - javascript_dir: js # the directory to put the version selector's JS - canonical_version: null # the version for ; `null` + version_selector: true # set to false to leave out the version selector + css_dir: css # the directory to put the version selector's CSS + javascript_dir: js # the directory to put the version selector's JS + canonical_version: + null # the version for ; `null` # uses the version specified via `mike deploy` markdown_extensions: - admonition @@ -91,8 +92,8 @@ markdown_extensions: - tables - pymdownx.details - 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.highlight: anchor_linenums: true use_pygments: true @@ -116,6 +117,6 @@ extra: - icon: fontawesome/brands/twitter link: https://twitter.com/rook_io - icon: fontawesome/solid/envelopes-bulk - link: 'https://groups.google.com/forum/#!forum/rook-dev' + link: "https://groups.google.com/forum/#!forum/rook-dev" - icon: fontawesome/brands/medium link: https://blog.rook.io/