updated mkdocs py package

.github/workflows/readme-publish.yml

@@ -1,20 +1,37 @@
 name: Publish docs via GitHub
 on:
+ workflow_dispatch:
  push:
  branches:
  - master
 
 jobs:
- build:
- name: Deploy docs
+ deploy:
  runs-on: ubuntu-latest
  steps:
- - name: Checkout master
- uses: actions/checkout@v1
- - name: remove requirements file
+ - name: Checkout repository
+ uses: actions/checkout@v3
+ with:
+ fetch-depth: 0
+ - uses: actions/setup-python@v4
+ with:
+ python-version: "3.10"
+ - name: Install Python dependencies
  run: |
- rm -Rf requirements.txt
- - name: Deploy docs
- uses: mhausenblas/mkdocs-deploy-gh-pages@1.16
+ pip install \
+ "wheel" \
+ "lxml" \
+ "mkdocs-material" \
+ "cairosvg>=2.5" \
+ "mkdocs-git-committers-plugin-2>=1.1.1" \
+ "mkdocs-git-revision-date-localized-plugin>=1.0" \
+ "mkdocs-minify-plugin>=0.3" \
+ "mkdocs-rss-plugin>=1.2" \
+ "mkdocs-redirects>=1.0" \
+ "pillow<10"
+ - name: Deploy documentation
  env:
- GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+ GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+ run: |
+ mkdocs gh-deploy --force
+ mkdocs --version

mkdocs.yml

@@ -9,12 +9,22 @@ repo_name: gee_asset_manager_addon
 repo_url: https://github.com/samapriya/gee_asset_manager_addon
 
 # Copyright
-copyright: 'Copyright © 2021 - 2022 Samapriya Roy'
-
+copyright: "Copyright © 2021 - 2022 Samapriya Roy"
 
 # Configuration
 theme:
- name: 'material'
+ name: "material"
+ features:
+ - announce.dismiss
+ - content.action.edit
+ - content.action.view
+ - content.code.annotate
+ - content.code.copy
+ - content.tooltips
+ - search.highlight
+ - search.share
+ - search.suggest
+ - toc.follow
 
  # 404 page
  static_templates:
@@ -27,9 +37,18 @@ theme:
  # Default values, taken from mkdocs_theme.yml
  language: en
  palette:
- scheme: default
- primary: red
- accent: blue
+ - scheme: default
+ primary: yellow
+ accent: indigo
+ toggle:
+ icon: material/toggle-switch-off-outline
+ name: Switch to dark mode
+ - scheme: slate
+ primary: red
+ accent: red
+ toggle:
+ icon: material/toggle-switch
+ name: Switch to light mode
  font:
  text: Google Sans
  code: Regular
@@ -44,11 +63,21 @@ extra:
  link: https://github.com/samapriya
  - icon: fontawesome/brands/medium
  link: https://medium.com/@samapriyaroy
+ - icon: fontawesome/brands/mastodon
+ link: https://mapstodon.space/@samapriya
  - icon: fontawesome/brands/twitter
  link: https://twitter.com/samapriyaroy
  - icon: fontawesome/brands/linkedin
  link: https://www.linkedin.com/in/samapriya
 
+plugins:
+ - search
+ - git-revision-date-localized:
+ enable_creation_date: true
+ type: timeago
+ - minify:
+ minify_html: true
+
 # Extensions
 markdown_extensions:
  - admonition
@@ -70,6 +99,9 @@ markdown_extensions:
  - pymdownx.emoji:
  emoji_index: !!python/name:materialx.emoji.twemoji
  emoji_generator: !!python/name:materialx.emoji.to_svg
+ options:
+ custom_icons:
+ - overrides/.icons
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.keys
@@ -89,26 +121,24 @@ markdown_extensions:
  custom_checkbox: true
  - pymdownx.tilde
 
-
-
 # Page tree
 nav:
  - Introduction: index.md
  - License: license.md
  - General Installation: installation.md
  - geeadd tools:
- - Quota tool: projects/quota.md
- - GEE app source: projects/app2script.md
- - Search GEE data catalog: projects/search.md
+  - Quota tool: projects/quota.md
+  - GEE app source: projects/app2script.md
+  - Search GEE data catalog: projects/search.md
  - Asset management tools:
- - Copy Assets: projects/copy.md
- - Move Assets: projects/move.md
- - Change asset permissions: projects/access.md
- - Delete assets: projects/delete.md
+  - Copy Assets: projects/copy.md
+  - Move Assets: projects/move.md
+  - Change asset permissions: projects/access.md
+  - Delete assets: projects/delete.md
  - Additional tools:
- - Asset Size: projects/size.md
- - Asset Report: projects/report.md
- - Task status: projects/task_status.md
- - Cancel tasks: projects/cancel_tasks.md
- - Delete asset metadata: projects/delete_metadata.md
+  - Asset Size: projects/size.md
+  - Asset Report: projects/report.md
+  - Task status: projects/task_status.md
+  - Cancel tasks: projects/cancel_tasks.md
+  - Delete asset metadata: projects/delete_metadata.md
  - Changelog: changelog.md