Save before commit

nautobot · Sep 1, 2023 · 1cafd89 · 1cafd89
1 parent 134dde5
commit 1cafd89
Show file tree

Hide file tree

Showing 3 changed files with 70 additions and 64 deletions.
diff --git a/.flake8 b/.flake8
@@ -1,5 +1,5 @@
 [flake8]
 ignore =
     E203,  # Black disagrees with this rule, as does PEP 8; Black wins
-    E501, # Line length is enforced by Black, so flake8 doesn't need to check it
+    E501,  # Line length is enforced by Black, so flake8 doesn't need to check it
     W503  # Black disagrees with this rule, as does PEP 8; Black wins
diff --git a/nautobot-app/{{ cookiecutter.project_slug }}/.github/workflows/ci.yml b/nautobot-app/{{ cookiecutter.project_slug }}/.github/workflows/ci.yml
@@ -82,7 +82,7 @@ jobs:
     strategy:
       fail-fast: true
       matrix:
-        python-version: ["3.11"]
+        python-version: ["3.8"]
         nautobot-version: ["{{cookiecutter.min_nautobot_version}}"]
     env:
       INVOKE_{{cookiecutter.plugin_name.upper()}}_PYTHON_VER: "${{ '{{ matrix.python-version }}' }}"

diff --git a/nautobot-app/{{ cookiecutter.project_slug }}/mkdocs.yml b/nautobot-app/{{ cookiecutter.project_slug }}/mkdocs.yml
@@ -1,56 +1,7 @@
 ---
+copyright: "Copyright &copy; The Authors"
 dev_addr: "127.0.0.1:8001"
 edit_uri: "edit/main/{{cookiecutter.project_slug}}/docs"
-site_dir: "{{cookiecutter.plugin_name}}/static/{{cookiecutter.plugin_name}}/docs"
-site_name: "{{cookiecutter.verbose_name}} Documentation"
-site_url: "{{cookiecutter.docs_app_url}}/"
-repo_url: "{{cookiecutter.repo_url}}"
-copyright: "Copyright &copy; The Authors"
-theme:
-  name: "material"
-  navigation_depth: 4
-  custom_dir: "docs/assets/overrides"
-  hljs_languages:
-    - "django"
-    - "yaml"
-  features:
-    - "navigation.tracking"
-    - "navigation.tabs"
-    - "navigation.tabs.sticky"
-    - "navigation.footer"
-    - "search.suggest"
-    - "search.highlight"
-    - "search.share"
-    - "navigation.indexes"
-    - "content.action.edit"
-    - "content.action.view"
-    - "content.code.copy"
-  favicon: "assets/favicon.ico"
-  logo: "assets/nautobot_logo.svg"
-  palette:
-    # Palette toggle for light mode
-    - media: "(prefers-color-scheme: light)"
-      scheme: "default"
-      primary: "black"
-      toggle:
-        icon: "material/weather-sunny"
-        name: "Switch to dark mode"
-
-    # Palette toggle for dark mode
-    - media: "(prefers-color-scheme: dark)"
-      scheme: "slate"
-      primary: "black"
-      toggle:
-        icon: "material/weather-night"
-        name: "Switch to light mode"
-extra_css:
-  - "assets/extra.css"
-
-# needed for RTD version flyout menu
-# jquery is not (yet) injected by RTD automatically and it might be dropped
-# as a dependency in the future
-extra_javascript:
-  - "https://code.jquery.com/jquery-3.6.0.min.js"
 
 extra:
   generator: false
@@ -71,6 +22,16 @@ extra:
     - icon: "fontawesome/brands/twitter"
       link: "https://twitter.com/networktocode"
       name: "Network to Code Twitter"
+
+extra_css:
+  - "assets/extra.css"
+
+# needed for RTD version flyout menu
+# jquery is not (yet) injected by RTD automatically and it might be dropped
+# as a dependency in the future
+extra_javascript:
+  - "https://code.jquery.com/jquery-3.6.0.min.js"
+
 markdown_extensions:
   - "admonition"
   - "toc":
@@ -83,18 +44,6 @@ markdown_extensions:
   - "pymdownx.snippets"
   - "pymdownx.superfences"
   - "footnotes"
-plugins:
-  - "search"
-  - "mkdocs-version-annotations"
-  - "mkdocstrings":
-      default_handler: "python"
-      handlers:
-        python:
-          paths: ["."]
-          options:
-            show_root_heading: true
-watch:
-  - "README.md"
 
 nav:
   - Overview: "index.md"
@@ -122,3 +71,60 @@ nav:
           - Package: "dev/code_reference/package.md"
           - API: "dev/code_reference/api.md"
   - Nautobot Docs Home ↗︎: "{{ cookiecutter.docs_base_url }}"
+
+plugins:
+  - "search"
+  - "mkdocs-version-annotations"
+  - "mkdocstrings":
+      default_handler: "python"
+      handlers:
+        python:
+          paths: ["."]
+          options:
+            show_root_heading: true
+
+repo_url: "{{cookiecutter.repo_url}}"
+site_dir: "{{cookiecutter.plugin_name}}/static/{{cookiecutter.plugin_name}}/docs"
+site_name: "{{cookiecutter.verbose_name}} Documentation"
+site_url: "{{cookiecutter.docs_app_url}}/"
+
+theme:
+  name: "material"
+  navigation_depth: 4
+  custom_dir: "docs/assets/overrides"
+  hljs_languages:
+    - "django"
+    - "yaml"
+  features:
+    - "navigation.tracking"
+    - "navigation.tabs"
+    - "navigation.tabs.sticky"
+    - "navigation.footer"
+    - "search.suggest"
+    - "search.highlight"
+    - "search.share"
+    - "navigation.indexes"
+    - "content.action.edit"
+    - "content.action.view"
+    - "content.code.copy"
+  favicon: "assets/favicon.ico"
+  logo: "assets/nautobot_logo.svg"
+  palette:
+    # Palette toggle for light mode
+    - media: "(prefers-color-scheme: light)"
+      scheme: "default"
+      primary: "black"
+      toggle:
+        icon: "material/weather-sunny"
+        name: "Switch to dark mode"
+
+    # Palette toggle for dark mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: "slate"
+      primary: "black"
+      toggle:
+        icon: "material/weather-night"
+        name: "Switch to light mode"
+
+watch:
+  - "README.md"