diff --git a/.github/workflows/deploy-pages.yml b/.github/workflows/deploy-pages.yml index 865b2cd..0f7a97c 100644 --- a/.github/workflows/deploy-pages.yml +++ b/.github/workflows/deploy-pages.yml @@ -1,8 +1,9 @@ -name: Deploy to GitHub Pages +name: Build Docs 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: diff --git a/docs/.overrides/partials/content_next.html b/docs/.overrides/partials/content_next.html index 6c38480..6ca1bc7 100644 --- a/docs/.overrides/partials/content_next.html +++ b/docs/.overrides/partials/content_next.html @@ -1,4 +1,11 @@ - + {% 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..4c0264e 100644 --- a/docs/.overrides/partials/nav-item.html +++ b/docs/.overrides/partials/nav-item.html @@ -1,4 +1,8 @@ - + {% macro render(nav_item, path, level) %} {% 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 tags supported +* [x] @mentions, #refs, [links](index.md), **formatting**, and tags 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