Merge pull request #147 from cdot65/pipeline-update

Pipeline update

Author: cdot65

.github/workflows/mkdocs-gh-pages.yml

@@ -24,7 +24,7 @@ jobs:
       - name: Setup Python
         uses: actions/setup-python@v4
         with:
-          python-version: "3.x"
+          python-version: "3.12"
 
       - name: Install dependencies
         run: |

.gitignore

@@ -172,3 +172,4 @@ pan_os_upgrade/components/example.py
 .idea
 poetry.lock
 settings.yaml
+.CLAUDE

mkdocs.yml

@@ -1,21 +1,84 @@
-site_name: pan-os-upgrade Documentation
+site_name: PAN-OS Upgrade Automation
 site_description: Automate upgrades of Palo Alto Networks firewalls with Python
 site_url: https://cdot65.github.io/pan-os-upgrade/
 repo_name: cdot65/pan-os-upgrade
 repo_url: https://github.com/cdot65/pan-os-upgrade
+site_dir: site
+copyright: Copyright © 2023-2025 Calvin Remsburg
+
 theme:
   name: material
+  logo: images/logo.svg
+  favicon: images/logo.svg
   language: en
   features:
+    - navigation.sections
+    - navigation.indexes
+    - navigation.top
     - navigation.tabs
+    - navigation.tabs.sticky
     - navigation.instant
+    - navigation.tracking
+    - navigation.footer
+    - content.code.copy
+    - content.code.annotate
+    - content.tabs.link
+  palette:
+    - scheme: default
+      primary: indigo
+      accent: indigo
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+    - scheme: slate
+      primary: indigo
+      accent: indigo
+      toggle:
+        icon: material/brightness-4
+        name: Switch to light mode
+
 plugins:
   - search
+  - autorefs:
+      link_titles: true
   - mkdocstrings:
       handlers:
         python:
-          rendering:
-            show_source: true
+          options:
+            show_source: false
+          selection:
+            docstring_style: google
+
+markdown_extensions:
+  - admonition
+  - pymdownx.highlight:
+      anchor_linenums: true
+      line_spans: __span
+      pygments_lang_class: true
+  - pymdownx.details
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - pymdownx.superfences
+  - pymdownx.tabbed:
+      alternate_style: true
+  - attr_list
+  - md_in_html
+  - tables
+  - footnotes
+
+# Explicitly set the layout for home page with customizations
+not_in_nav: |
+  index.md
+
+extra_css:
+  - css/termynal.css
+  - css/custom.css
+
+extra_javascript:
+  - js/termynal.js
+  - js/custom.js
+
+# Define the navigation menu
 nav:
   - Home: index.md
   - User Guide:
@@ -34,9 +97,3 @@ nav:
       - License: about/license.md
       - Contributing: about/contributing.md
       - Release Notes: about/release-notes.md
-extra_css:
-  - css/termynal.css
-  - css/custom.css
-extra_javascript:
-  - js/termynal.js
-  - js/custom.js

pyproject.toml

@@ -50,12 +50,19 @@ colorama = "^0.4.6"
 black = "^23.12.1"
 flake8 = "^7.0.0"
 ipdb = "^0.13.13"
+# MkDocs and related dependencies
+mkdocs = "^1.6.0"
 mkdocs-material = "^9.5.4"
-mkdocstrings = "^0.24.0"
+mkdocstrings = {extras = ["python"], version = "^0.24.0"}
+mkdocs-autorefs = "^0.4.1"  # Using a compatible version for current setup
+termynal = "^0.12.1"  # Use termynal package instead of mkdocs-termynal
+# Testing related
 pytest = "^7.4.4"
-python-dotenv = "^1.0.1"
 pytest-mock = "^3.12.0"
+pytest-cov = "^4.1.0"
+python-dotenv = "^1.0.1"
 prompt-toolkit = "^3.0.43"
+rich = "^13.7.0"  # For better console output
 
 [tool.poetry.scripts]
 pan-os-upgrade = 'pan_os_upgrade.main:app'