Update mkdocs package versions

gtjoseph · gtjoseph · commit 0647c843d727 · 2024-02-02T08:52:18.000-07:00
Notable updates:
mkdocs updated to 1.5.3
mkdocs-material updated to 9.5.6
pymdown-extensions updated to 10.4

You should delete your local virtualenv and re-create it
from the new requirements.txt.
diff --git a/README.md b/README.md
@@ -2,6 +2,10 @@
 
 This repository contains the Asterisk Documentation project.
 
+# Recent Changes
+
+The packages used to create the documentation were upgraded on February 2 2024.  While there are no breaking changes, some new capabilities were added that, if used going forward, won't render correctly with the older versions.  So, if you build documentation locally, you should delete your local virtualenv and re-create it using the new requirements.txt file.  The new features will be documented separately.
+
 # Static Documentation
 
 The static documentation contained in the ./docs/ directory is written directly in markdown.  The publish process uses [mkdocs](https://www.mkdocs.org) and [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) to generate the HTML web site.  The directory structure is fairly straightforward so if you wish to contribute, you should fork this repository and submit pull requests against files in that directory.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -5,6 +5,11 @@ repo_name: Asterisk
 copyright: >
   Content is licensed under a Creative Commons Attribution-ShareAlike 3.0 United States License.
 
+validation:
+  absolute_links: ignore
+  unrecognized_links: ignore
+
+
 theme:
   name: material
   favicon: favicon.ico
@@ -85,34 +90,34 @@ markdown_extensions:
   - def_list
   - footnotes
   - md_in_html
+  - tables
+  - toc:
+      permalink: true
+  - pymdownx.betterem
+  - pymdownx.blocks.admonition
+  - pymdownx.caret
+  - pymdownx.critic
+  - pymdownx.details
+  - pymdownx.emoji:
+      emoji_index: !!python/name:material.extensions.emoji.twemoji
+      emoji_generator: !!python/name:material.extensions.emoji.to_svg
   - pymdownx.highlight:
       anchor_linenums: true
       line_spans: __span
       pygments_lang_class: true
   - pymdownx.inlinehilite
+  - pymdownx.keys
+  - pymdownx.mark
+  - pymdownx.saneheaders
+  - pymdownx.smartsymbols
   - pymdownx.snippets
   - pymdownx.superfences:
       custom_fences:
         - name: mermaid
           class: mermaid
           format: !!python/name:pymdownx.superfences.fence_code_format
-  - footnotes
-  - tables
-  - pymdownx.critic
-  - pymdownx.caret
-  - pymdownx.keys
-  - pymdownx.mark
-  - pymdownx.tilde
-  - pymdownx.emoji:
-      emoji_index: !!python/name:materialx.emoji.twemoji
-      emoji_generator: !!python/name:materialx.emoji.to_svg
-  - pymdownx.snippets
-  - pymdownx.details
-  - pymdownx.betterem
-  - pymdownx.smartsymbols
   - pymdownx.tabbed:
       alternate_style: true
-  - toc:
-      permalink: true
+  - pymdownx.tilde
 
 
diff --git a/requirements.txt b/requirements.txt
@@ -1,8 +1,9 @@
-mkdocs==1.4.3
-mkdocs-git-revision-date-localized-plugin==1.2.0
-mkdocs-material==9.2.0b0
-mkdocs-material-extensions==1.1.1
-mkdocs-table-reader-plugin==2.0.1
-mkdocs-awesome-pages-plugin==2.9.1
-mkdocs-minify-plugin==0.7.0
+mkdocs==1.5.3
+mkdocs-awesome-pages-plugin==2.9.2
+mkdocs-git-revision-date-localized-plugin==1.2.2
+mkdocs-material==9.5.6
+mkdocs-material-extensions==1.3.1
+mkdocs-minify-plugin==0.8.0
+mkdocs-table-reader-plugin==2.1.0
 lxml==4.9.3
+pymdown-extensions==10.4
