Refresh mkdocs files

Author: mdmintz

mkdocs.yml

@@ -25,8 +25,8 @@ markdown_extensions:
   - pymdownx.highlight
   - pymdownx.superfences
   - pymdownx.inlinehilite
-  - pymdownx.details
-  - pymdownx.snippets
+  # - pymdownx.details
+  # - pymdownx.snippets
 # Configuration
 theme:
   name: material
@@ -43,18 +43,20 @@ theme:
     - 404.html
   features:
     # - search.highlight
-    - toc.integrate
-    - navigation.indexes
-    # - navigation.sections
+    # - toc.integrate
+    - toc.hide
+    # - navigation.indexes
+    - toc.follow
+    - navigation.sections
     # - navigation.expand
     # - navigation.tabs
     - navigation.top
     - navigation.tracking
     - navigation.instant
   palette:
     scheme: default
-    primary: teal
-    accent: indigo
+    primary: blue
+    accent: green
   font:
     text: Roboto
     code: Roboto Mono
@@ -70,9 +72,12 @@ plugins:
         - CODE_OF_CONDUCT.md
         - CONTRIBUTING.md
         - SECURITY.md
+        - examples/case_summary.md
         - help_docs/chinese.md
         - help_docs/mysql_installation.md
         - integrations/katalon/ReadMe.md
+        - help_docs/verify_webdriver.md
+        - help_docs/webdriver_installation.md
         - seleniumbase/utilities/selenium_ide/ReadMe.md
         - seleniumbase/examples/chart_maker/ReadMe.md
   - minify:
@@ -82,61 +87,46 @@ plugins:
         on_pre_build: mkdocs_build.prepare:main
 # Page tree
 nav:
-  - SeleniumBase ReadMe: README.md
-  - List of Features: help_docs/features_list.md
-  - Running Example Tests: examples/ReadMe.md
-  - Command Line Options: help_docs/customizing_test_runs.md
-  - Dashboard / Reports: examples/example_logs/ReadMe.md
-  - GUI / Commander: help_docs/commander.md
-  - Console Scripts: seleniumbase/console_scripts/ReadMe.md
-  - Syntax Formats: help_docs/syntax_formats.md
-  - Recorder Mode: help_docs/recorder_mode.md
-  - API Reference: help_docs/method_summary.md
-  - Case Plans: help_docs/case_plans.md
-  - Setup / Install:
-    - Install Python, pip, git: help_docs/install_python_pip_git.md
-    - Virtualenv Instructions: help_docs/virtualenv_instructions.md
-    - Install SeleniumBase: help_docs/install.md
-    - WebDriver Installation: help_docs/webdriver_installation.md
-    - Verifying WebDriver: help_docs/verify_webdriver.md
-    - How it Works: help_docs/how_it_works.md
-  - Behave-BDD Integration:
-    - Behave-BDD ReadMe: examples/behave_bdd/ReadMe.md
-    - Behave-BDD GUI App: help_docs/behave_gui.md
-  - Languages:
-    - Translations: help_docs/translations.md
-    - Chinese Docs: help_docs/chinese.md
-    - Locale Codes: help_docs/locale_codes.md
-  - JS Generators:
-    - Demo Mode: help_docs/demo_mode.md
-    - Tour Maker: examples/tour_examples/ReadMe.md
-    - Dialog Boxes: examples/dialog_boxes/ReadMe.md
-    - Chart Maker: help_docs/chart_maker.md
-    - Presentation Maker: examples/presenter/ReadMe.md
+  - ✅ SeleniumBase README: README.md
+  - 🏰 List of Features: help_docs/features_list.md
+  - 📚 Running Example Tests: examples/ReadMe.md
+  - 🎛️ Command Line Options: help_docs/customizing_test_runs.md
+  - 📊 Dashboard / Reports: examples/example_logs/ReadMe.md
+  - 🎖️ GUI / Commander: help_docs/commander.md
+  - 🔮 Console Scripts: seleniumbase/console_scripts/ReadMe.md
+  - 🔡 Syntax Formats: help_docs/syntax_formats.md
+  - 🔴 Recorder Mode: help_docs/recorder_mode.md
+  - 📗 API Reference: help_docs/method_summary.md
+  - Python Setup / Install:
+    - 🐍 Get Python, pip, & git: help_docs/install_python_pip_git.md
+    - ⚙️ Virtualenv Instructions: help_docs/virtualenv_instructions.md
+    - 🏄 Install SeleniumBase: help_docs/install.md
+    - 👁️ How it Works: help_docs/how_it_works.md
+  - JS Manager / JS Tools:
+    - 🕹️ Package Manager: help_docs/js_package_manager.md
+    - 🎦 Demo Mode: help_docs/demo_mode.md
+    - 🚎 Tour Maker: examples/tour_examples/ReadMe.md
+    - 🛂 Dialog Boxes: examples/dialog_boxes/ReadMe.md
+    - 📶 Chart Maker: help_docs/chart_maker.md
+    - 🎞️ Presentation Maker: examples/presenter/ReadMe.md
   - Integrations:
-    - Mobile Testing: help_docs/mobile_testing.md
-    - GitHub CI: integrations/github/workflows/ReadMe.md
-    - Visual Testing: examples/visual_testing/ReadMe.md
-    - Selenium Grid: seleniumbase/utilities/selenium_grid/ReadMe.md
-    - HighCharts: examples/chart_maker/ReadMe.md
-    - MasterQA: examples/master_qa/ReadMe.md
-    - Azure Pipelines: integrations/azure/azure_pipelines/ReadMe.md
-    - Jenkins on Azure: integrations/azure/jenkins/ReadMe.md
-    - Jenkins on Google Cloud: integrations/google_cloud/ReadMe.md
-    - NodeJS Test Runner: https://github.com/seleniumbase/SeleniumBase/tree/master/integrations/node_js
-  - Help Docs:
-    - Table of Contents: help_docs/ReadMe.md
-    - JS Package Manager: help_docs/js_package_manager.md
-    - Master QA Hybrid Mode: seleniumbase/masterqa/ReadMe.md
-    - Decorators / Security: seleniumbase/common/ReadMe.md
-    - Desired Capabilities: help_docs/desired_capabilities.md
-    - Docker Start Guide: integrations/docker/ReadMe.md
-    - Using Safari Driver: help_docs/using_safari_driver.md
-    - Shadow DOM Support: help_docs/shadow_dom.md
-    - The HTML Inspector: help_docs/html_inspector.md
-    - macOS Hidden Files: help_docs/hidden_files_info.md
-    - MySQL Instructions: help_docs/mysql_installation.md
-    - Useful grep commands: help_docs/useful_grep_commands.md
+    - 📱 Mobile Testing: help_docs/mobile_testing.md
+    - 🤖 GitHub CI: integrations/github/workflows/ReadMe.md
+    - 🗂️ Case Plans: help_docs/case_plans.md
+    - 🖼️ Visual Testing: examples/visual_testing/ReadMe.md
+    - 🔎 The HTML Inspector: help_docs/html_inspector.md
+    - 🌐 Selenium Grid: seleniumbase/utilities/selenium_grid/ReadMe.md
+    - 📶 HighCharts: examples/chart_maker/ReadMe.md
+    - 🛂 MasterQA: examples/master_qa/ReadMe.md
+    - 🤖 Azure Pipelines: integrations/azure/azure_pipelines/ReadMe.md
+    - 🤖 Jenkins on Azure: integrations/azure/jenkins/ReadMe.md
+    - 🤖 Jenkins on Google Cloud: integrations/google_cloud/ReadMe.md
+    - 🤖 NodeJS Test Runner: https://github.com/seleniumbase/SeleniumBase/tree/master/integrations/node_js
+  - Presentations:
+    - Presenter Demo: https://seleniumbase.io/other/presenter.html
+    - Core Presentation: https://seleniumbase.io/other/core_presentation.html
+    - Chart Maker Demo: https://seleniumbase.io/other/chart_presentation.html
+    - Python Virtual Envs: https://seleniumbase.io/other/py_virtual_envs.html
   - Demo Pages:
     - Demo Page (Test Page): https://seleniumbase.io/demo_page
     - MFA Login (Test App): https://seleniumbase.io/realworld/login
@@ -157,11 +147,27 @@ nav:
     - Canvas Test Page One: https://seleniumbase.io/canvas/
     - Canvas Test Page Two: https://seleniumbase.io/other/canvas
     - Shadow DOM/Root Page: https://seleniumbase.io/other/shadow_dom
-  - Presentations:
-    - Presenter Demo: https://seleniumbase.io/other/presenter.html
-    - Core Presentation: https://seleniumbase.io/other/core_presentation.html
-    - Chart Maker Demo: https://seleniumbase.io/other/chart_presentation.html
-    - Python Virtual Envs: https://seleniumbase.io/other/py_virtual_envs.html
+  - Additional Help Docs:
+    - Table of Contents: help_docs/ReadMe.md
+    - Decorators / Security: seleniumbase/common/ReadMe.md
+    - Desired Capabilities: help_docs/desired_capabilities.md
+    - Docker Start Guide: integrations/docker/ReadMe.md
+    - Using Safari Driver: help_docs/using_safari_driver.md
+    - Shadow DOM Support: help_docs/shadow_dom.md
+    - macOS Hidden Files: help_docs/hidden_files_info.md
+    - MySQL Instructions: help_docs/mysql_installation.md
+    - Master QA Hybrid Mode: seleniumbase/masterqa/ReadMe.md
+    - Case Plans (examples): examples/case_summary.md
+    - Useful grep commands: help_docs/useful_grep_commands.md
+    - WebDriver Installation: help_docs/webdriver_installation.md
+    - Verifying WebDriver: help_docs/verify_webdriver.md
+  - Behave-BDD Integration:
+    - Behave-BDD ReadMe: examples/behave_bdd/ReadMe.md
+    - Behave-BDD GUI App: help_docs/behave_gui.md
+  - Languages:
+    - Translations: help_docs/translations.md
+    - Chinese Docs: help_docs/chinese.md
+    - Locale Codes: help_docs/locale_codes.md
   - Other:
     - YouTube Link: https://www.youtube.com/playlist?list=PLp9uKicxkBc5UIlGi2BuE3aWC7JyXpD3m
     - Case Studies: help_docs/happy_customers.md

mkdocs_build/prepare.py

@@ -75,12 +75,14 @@ def main(*args, **kwargs):
     files_to_process = ["README.md"]
     scanned_dir_list = []
     scanned_dir_list.append("help_docs")
+    scanned_dir_list.append("examples")
     scanned_dir_list.append("examples/example_logs")
     scanned_dir_list.append("examples/presenter")
     scanned_dir_list.append("examples/chart_maker")
     scanned_dir_list.append("examples/tour_examples")
     scanned_dir_list.append("examples/visual_testing")
     scanned_dir_list.append("integrations/google_cloud")
+    scanned_dir_list.append("seleniumbase/console_scripts")
     for scanned_dir in scanned_dir_list:
         for dir_ in os.listdir(ROOT_DIR / scanned_dir):
             files_to_process.append(os.path.join(scanned_dir, dir_))
@@ -122,6 +124,16 @@ def main(*args, **kwargs):
             if ' href="' in line and '.md"' in line:
                 changed = True
                 line = line.replace('.md"', '/"')
+            if "<!-- Hide TOC -->" in line:
+                changed = True
+                new_lines = []
+                new_lines.append("---")
+                new_lines.append("hide:")
+                new_lines.append("  - toc")
+                new_lines.append("---")
+                for line in new_lines:
+                    seleniumbase_lines.append(line)
+                continue
             if "<!-- View on GitHub -->" in line:
                 changed = True
                 line = (

mkdocs_build/requirements.txt

@@ -8,7 +8,7 @@ livereload==2.6.3
 joblib==1.2.0
 Markdown==3.3.7
 MarkupSafe==2.1.1
-keyring==23.9.3
+keyring==23.10.0
 pkginfo==1.8.3
 Jinja2==3.1.2
 click==8.1.3
@@ -29,7 +29,7 @@ cssselect2==0.7.0
 tinycss2==1.2.1
 defusedxml==0.7.1
 mkdocs==1.4.2
-mkdocs-material==8.5.7
+mkdocs-material==8.5.8
 mkdocs-exclude-search==0.6.4
 mkdocs-simple-hooks==0.1.5
 mkdocs-material-extensions==1.1