[CLEANUP][DOCS]

docs/mkdocs.yml

@@ -10,36 +10,36 @@ copyright: TGSC Corp 2024. All rights reserved.
 
 
 plugins:
-  # - glightbox
   - search
   - git-authors
   - mkdocs-jupyter:
       kernel_name: python3
       execute: false
       include_source: True
-        include_requirejs: true
+      include_requirejs: True
   - mkdocstrings:
       default_handler: python
       handlers:
         python:
           options:
-            parameter_headings: true
+            parameter_headings: True
             paths: [supervision]
-            load_external_modules: true
-            allow_inspection: true
-            show_bases: true
-            group_by_category: true
+            load_external_modules: True
+            allow_inspection: True
+            show_bases: True
+            group_by_category: True
             docstring_style: google
-            show_symbol_type_heading: true
-            show_symbol_type_toc: true
-            show_category_heading: true
+            show_symbol_type_heading: True
+            show_symbol_type_toc: True
+            show_category_heading: True
           domains: [std, py]
-  - git-committers:
-      repository: kyegomez/swarms
-      branch: master
-      # token: !ENV ["GITHUB_TOKEN"]
   - git-revision-date-localized:
-      enable_creation_date: true
+      enable_creation_date: True
+  - versioning
+  - table-of-contents
+  - mermaid2
+  - disqus:
+      site_name: your-disqus-site-name
 extra_css:
   - assets/css/extra.css
 extra:
@@ -48,18 +48,19 @@ extra:
       link: https://x.com/KyeGomezB
     - icon: fontawesome/brands/github
       link: https://github.com/kyegomez/swarms
+  analytics:
+    provider: google
+    tracking_id: YOUR_TRACKING_ID
 theme:
   name: material
   custom_dir: overrides
   logo: assets/img/SwarmsLogoIcon.png
   palette:
-      # Palette toggle for light mode
     - scheme: default
       primary: black
       toggle:
         icon: material/brightness-7 
         name: Switch to dark mode
-    # Palette toggle for dark mode
     - scheme: slate
       primary: black
       toggle:
@@ -73,11 +74,13 @@ theme:
     - navigation.expand
     - navigation.top
     - announce.dismiss
+    - toc.integrate
+    - toc.expand
 markdown_extensions:
   - pymdownx.highlight:
-      anchor_linenums: true
+      anchor_linenums: True
       line_spans: __span
-      pygments_lang_class: true
+      pygments_lang_class: True
   - admonition
   - pymdownx.inlinehilite
   - pymdownx.snippets
@@ -87,6 +90,9 @@ markdown_extensions:
   - tables
   - def_list
   - footnotes
+  - pymdownx.mermaid
+  - toc
+  - pymdownx.tasklist
 nav:
   - Home:
     - Overview: "index.md"
@@ -104,10 +110,8 @@ nav:
       - Overview: "swarms/structs/index.md"
       - Build Agents: "swarms/structs/diy_your_own_agent.md"
       - Agents with Memory: "swarms/memory/diy_memory.md"
-      - Agents with tools: "swarms/tools/main.md"
-      - DIY Build Your Own Agent: "diy_your_own_agent.md"
+      - Agents with Tools: "swarms/tools/main.md"
       - Equipping Autonomous Agents with Tools: "examples/tools_agent.md"
-      - Functions, Pydantic BaseModels, and More: "swarms/tools/main.md"
     - Multi-Agent Collaboration:
       - Overview: "swarms/structs/multi_agent_orchestration.md"
       - Workflows: "swarms/structs/workflows.md"

docs/requirements.txt

@@ -20,3 +20,14 @@ mkdocs-enumerate-headings-plugin
 mkdocs-autolinks-plugin
 mkdocs-minify-html-plugin
 mkdocs-autolinks-plugin
+mkdocs-search>=2.9.0
+mkdocs-git-authors-plugin>=0.5.1
+mkdocs-jupyter>=0.20.0
+mkdocstrings>=0.18.1
+mkdocs-git-revision-date-localized-plugin>=0.9.1
+mkdocs-mermaid2-plugin>=0.6.0
+mkdocs-disqus>=0.2.0
+pymdown-extensions>=9.4
+markdown>=3.3.6
+mkdocs-material-extensions>=1.0
+pygments>=2.10.0