From c74279da3cb0fba2d0a871fab53cac9bb49b443d Mon Sep 17 00:00:00 2001
From: Talley Lambert <talley.lambert@gmail.com>
Date: Sun, 3 Mar 2024 10:29:33 -0500
Subject: [PATCH 1/4] docs: pin docs reqs and fix build

---
 docs/.overrides/partials/content_next.html |  9 ++++++++-
 docs/.overrides/partials/nav-item.html     |  6 +++++-
 docs/demo.md                               |  6 +++---
 mkdocs.yml                                 |  2 +-
 requirements.txt                           | 12 ++++++------
 5 files changed, 23 insertions(+), 12 deletions(-)

diff --git a/docs/.overrides/partials/content_next.html b/docs/.overrides/partials/content_next.html
index 6c38480..71e7def 100644
--- a/docs/.overrides/partials/content_next.html
+++ b/docs/.overrides/partials/content_next.html
@@ -1,4 +1,11 @@
-<!-- Link to previous and/or next page -->
+<!-- Link to previous and/or next page 
+
+    This code is borrowed from footer.html, and is enabled by adding
+    "navigation.content_next" to the features list in mkdocs.yml.
+
+    It puts the next and previous page links at the bottom of the content
+    instead of the bottom of the page.
+-->
 {% if "navigation.content_next" in features %}
     {% if page.previous_page or page.next_page %}
         {% if page.meta and page.meta.hide %}
diff --git a/docs/.overrides/partials/nav-item.html b/docs/.overrides/partials/nav-item.html
index 11092b8..f5dbc3e 100644
--- a/docs/.overrides/partials/nav-item.html
+++ b/docs/.overrides/partials/nav-item.html
@@ -1,4 +1,8 @@
-<!-- Wrap everything with a macro to reduce file roundtrips (see #2213) -->
+<!-- 
+    This partial is modified to render icons in navigation,
+    but it is no longer necessary after mkdocs-material mkdocs-material 9.2
+    since that version includes the feature by default.
+ -->
 {% macro render(nav_item, path, level) %}
     <!-- Determine class according to state -->
     {% set class = "md-nav__item" %}
diff --git a/docs/demo.md b/docs/demo.md
index e9cdd15..602a18b 100644
--- a/docs/demo.md
+++ b/docs/demo.md
@@ -117,7 +117,7 @@ Run the command: `pip install my_package`
 
 ## Task Lists
 
-* [x] @mentions, #refs, [links](index), **formatting**, and <del>tags</del> supported
+* [x] @mentions, #refs, [links](index.md), **formatting**, and <del>tags</del> supported
 * [x] list syntax required (any unordered or ordered list supported)
 * [x] this is a complete item
 * [ ] this is an incomplete item
@@ -234,8 +234,8 @@ for customizing the icon
 
 ## Buttons
 
-[Subscribe to our newsletter](index){ .md-button .md-button--primary }
+[Subscribe to our newsletter](index.md){ .md-button .md-button--primary }
 
 with icons
 
-[Send :fontawesome-solid-paper-plane:](index){ .md-button }
+[Send :fontawesome-solid-paper-plane:](index.md){ .md-button }
diff --git a/mkdocs.yml b/mkdocs.yml
index 7f7508c..0ecdeb2 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -59,7 +59,7 @@ nav:
       - Pre-commit: guides/pre-commit.md
       - Dependency Management: guides/dependencies.md
   - Glossary: glossary.md
-  - "[md demo]": demo.md
+  # - "[md demo]": demo.md
 
 theme:
   name: material
diff --git a/requirements.txt b/requirements.txt
index e5220d5..a00be72 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -1,6 +1,6 @@
-mkdocs
-mkdocs-material
-mkdocs-spellcheck[all]
-mkdocs-git-revision-date-localized-plugin
-mkdocs-git-committers-plugin
-mkdocs-minify-plugin
+mkdocs-material==9.1.18
+mkdocs-material-extensions==1.2
+mkdocs-spellcheck[all]==1.0.2
+mkdocs-git-revision-date-localized-plugin==1.2.4
+mkdocs-git-committers-plugin==0.2.3
+mkdocs-minify-plugin==0.8.0

From 859718290d40e0f2230a9ab0c46685a3b4e199b5 Mon Sep 17 00:00:00 2001
From: "pre-commit-ci[bot]"
 <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Date: Sun, 3 Mar 2024 15:30:50 +0000
Subject: [PATCH 2/4] [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci
---
 docs/.overrides/partials/content_next.html | 2 +-
 docs/.overrides/partials/nav-item.html     | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/docs/.overrides/partials/content_next.html b/docs/.overrides/partials/content_next.html
index 71e7def..6ca1bc7 100644
--- a/docs/.overrides/partials/content_next.html
+++ b/docs/.overrides/partials/content_next.html
@@ -1,4 +1,4 @@
-<!-- Link to previous and/or next page 
+<!-- Link to previous and/or next page
 
     This code is borrowed from footer.html, and is enabled by adding
     "navigation.content_next" to the features list in mkdocs.yml.
diff --git a/docs/.overrides/partials/nav-item.html b/docs/.overrides/partials/nav-item.html
index f5dbc3e..4c0264e 100644
--- a/docs/.overrides/partials/nav-item.html
+++ b/docs/.overrides/partials/nav-item.html
@@ -1,4 +1,4 @@
-<!-- 
+<!--
     This partial is modified to render icons in navigation,
     but it is no longer necessary after mkdocs-material mkdocs-material 9.2
     since that version includes the feature by default.

From ebbdccc5735f2752e936ab3c5e1e826d2395cd90 Mon Sep 17 00:00:00 2001
From: Talley Lambert <talley.lambert@gmail.com>
Date: Sun, 3 Mar 2024 10:33:05 -0500
Subject: [PATCH 3/4] run build on PR

---
 .github/workflows/deploy-pages.yml | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/.github/workflows/deploy-pages.yml b/.github/workflows/deploy-pages.yml
index 865b2cd..5e58375 100644
--- a/.github/workflows/deploy-pages.yml
+++ b/.github/workflows/deploy-pages.yml
@@ -3,6 +3,7 @@ name: Deploy to GitHub Pages
 on:
   push:
     branches: [main]
+  pull_request:
   workflow_dispatch:
 
 # Allow this job to clone the repo and create a page deployment
@@ -45,6 +46,7 @@ jobs:
           path: "site/"
 
   deploy:
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
     needs: build
     runs-on: ubuntu-latest
     environment:

From d9767185050b9ca756fb3b834f807853cd7f5aa5 Mon Sep 17 00:00:00 2001
From: Talley Lambert <talley.lambert@gmail.com>
Date: Sun, 3 Mar 2024 10:33:44 -0500
Subject: [PATCH 4/4] rename action

---
 .github/workflows/deploy-pages.yml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/.github/workflows/deploy-pages.yml b/.github/workflows/deploy-pages.yml
index 5e58375..0f7a97c 100644
--- a/.github/workflows/deploy-pages.yml
+++ b/.github/workflows/deploy-pages.yml
@@ -1,4 +1,4 @@
-name: Deploy to GitHub Pages
+name: Build Docs
 
 on:
   push: