lots of indents mkdocs

1 year ago · e36cf6b435
parent e7cbb29e49
commit e36cf6b435
1 changed files with 79 additions and 78 deletions
--- a/mkdocs.yml
+++ b/mkdocs.yml
@ -1,3 +1,4 @@
+---
 site_name: Swarms Docs
 plugins:
  - glightbox
@ -19,15 +20,15 @@ extra:
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/Swarms/
 theme:
-    name: material
-    custom_dir: docs/overrides
-    logo: assets/img/SwarmsLogoIcon.png
-    palette:
-      # Palette toggle for light mode
+  name: material
+  custom_dir: docs/overrides
+  logo: assets/img/SwarmsLogoIcon.png
+  palette:
+    # Palette toggle for light mode
    - scheme: default
      primary: black
      toggle:
-        icon: material/brightness-7 
+        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - scheme: slate
@ -35,14 +36,14 @@ theme:
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
-    features:
-        - content.code.copy
-        - content.code.annotate
-        - navigation.tabs
-        - navigation.sections
-        - navigation.expand
-        - navigation.top
-        - announce.dismiss
+  features:
+    - content.code.copy
+    - content.code.annotate
+    - navigation.tabs
+    - navigation.sections
+    - navigation.expand
+    - navigation.top
+    - announce.dismiss
 markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
@ -58,25 +59,25 @@ markdown_extensions:
  - def_list
  - footnotes
 nav:
- Home:
-    - Overview: "index.md"
-    - Contributing: "contributing.md"
-    - Docker Container Setup: "docker_setup.md"
- Swarms:
-  - Overview: "swarms/index.md"
+  - Home:
+      - Overview: "index.md"
+  - Contributing: "contributing.md"
+  - Docker Container Setup: "docker_setup.md"
+  - Swarms:
+      - Overview: "swarms/index.md"
  - swarms.swarms:
-    - AbstractSwarm: "swarms/swarms/abstractswarm.md"
-    - GodMode: "swarms/swarms/godmode.md"
-    - Groupchat: "swarms/swarms/groupchat.md"
+      - AbstractSwarm: "swarms/swarms/abstractswarm.md"
+      - GodMode: "swarms/swarms/godmode.md"
+      - Groupchat: "swarms/swarms/groupchat.md"
  - swarms.workers:
-    - Overview: "swarms/workers/index.md"
-    - AbstractWorker: "swarms/workers/abstract_worker.md"
+      - Overview: "swarms/workers/index.md"
+      - AbstractWorker: "swarms/workers/abstract_worker.md"
  - swarms.agents:
-    - AbstractAgent: "swarms/agents/abstract_agent.md"
-    - OmniModalAgent: "swarms/agents/omni_agent.md"
+      - AbstractAgent: "swarms/agents/abstract_agent.md"
+      - OmniModalAgent: "swarms/agents/omni_agent.md"
  - swarms.models:
-    - Language:  
-      - Overview: "swarms/models/index.md"
+      - Language:
+          - Overview: "swarms/models/index.md"
      - HuggingFaceLLM: "swarms/models/huggingface.md"
      - Anthropic: "swarms/models/anthropic.md"
      - OpenAI: "swarms/models/openai.md"
@ -84,54 +85,54 @@ nav:
      - BioGPT: "swarms/models/biogpt.md"
      - MPT7B: "swarms/models/mpt.md"
      - Mistral: "swarms/models/mistral.md"
-    - MultiModal:
-      - Fuyu: "swarms/models/fuyu.md"
-      - Vilt: "swarms/models/vilt.md"
-      - Idefics: "swarms/models/idefics.md"
-      - BingChat: "swarms/models/bingchat.md"
-      - Kosmos: "swarms/models/kosmos.md"
-      - Nougat: "swarms/models/nougat.md"
-      - Dalle3: "swarms/models/dalle3.md"
-      - GPT4V: "swarms/models/gpt4v.md"
-      - LayoutLMDocumentQA: "swarms/models/layoutlm_document_qa.md"
-      - DistilWhisperModel: "swarms/models/distilled_whisperx.md"
-      - ElevenLabsText2SpeechTool: "swarms/models/elevenlabs.md"
+      - MultiModal:
+          - Fuyu: "swarms/models/fuyu.md"
+          - Vilt: "swarms/models/vilt.md"
+          - Idefics: "swarms/models/idefics.md"
+          - BingChat: "swarms/models/bingchat.md"
+          - Kosmos: "swarms/models/kosmos.md"
+          - Nougat: "swarms/models/nougat.md"
+          - Dalle3: "swarms/models/dalle3.md"
+          - GPT4V: "swarms/models/gpt4v.md"
+          - LayoutLMDocumentQA: "swarms/models/layoutlm_document_qa.md"
+          - DistilWhisperModel: "swarms/models/distilled_whisperx.md"
+          - ElevenLabsText2SpeechTool: "swarms/models/elevenlabs.md"
  - swarms.structs:
-    - Overview: "swarms/structs/overview.md"
-    - AutoScaler: "swarms/swarms/autoscaler.md"
-    - Flow: "swarms/structs/flow.md"
-    - SequentialWorkflow: 'swarms/structs/sequential_workflow.md'
+      - Overview: "swarms/structs/overview.md"
+      - AutoScaler: "swarms/swarms/autoscaler.md"
+      - Flow: "swarms/structs/flow.md"
+      - SequentialWorkflow: 'swarms/structs/sequential_workflow.md'
  - swarms.memory:
-    - PineconeVectorStoreStore: "swarms/memory/pinecone.md"
-    - PGVectorStore: "swarms/memory/pg.md"
-  # - swarms.chunkers: 
-  #   - BaseChunker: "swarms/chunkers/basechunker.md"
-  #   - PdfChunker: "swarms/chunkers/pdf_chunker.md"
- Guides:
-    - Overview: "examples/index.md"
-    - Agents:
-      - Flow: "examples/flow.md"
-      - SequentialWorkflow: "examples/reliable_autonomous_agents.md"
-      - OmniAgent: "examples/omni_agent.md"
-    - 2O+ Autonomous Agent Blogs: "examples/ideas.md"
- Applications:
-    - CustomerSupport: 
-      - Overview: "applications/customer_support.md"
-    - Marketing: 
-      - Overview: "applications/marketing_agencies.md" 
- Corporate:
-    - FAQ: "corporate/faq.md"
-    - Purpose: "corporate/purpose.md"
-    - Roadmap: "corporate/roadmap.md"
-    - Weaknesses: "corporate/failures.md"
-    - Design: "corporate/design.md"
-    - Flywheel: "corporate/flywheel.md"
-    - Bounties: "corporate/bounties.md"
-    - Metric: "corporate/metric.md"
-    - Distribution: "corporate/distribution"
-    - Research: "corporate/research.md"
-    - Demos: "corporate/demos.md"
-    - Architecture: "corporate/architecture.md"
-    - Checklist: "corporate/checklist.md"
-    - Hiring: "corporate/hiring.md"
-    - SwarmCloud: "corporate/swarm_cloud.md"
+      - PineconeVectorStoreStore: "swarms/memory/pinecone.md"
+      - PGVectorStore: "swarms/memory/pg.md"
+# - swarms.chunkers:
+#   - BaseChunker: "swarms/chunkers/basechunker.md"
+#   - PdfChunker: "swarms/chunkers/pdf_chunker.md"
+  - Guides:
+      - Overview: "examples/index.md"
+      - Agents:
+          - Flow: "examples/flow.md"
+          - SequentialWorkflow: "examples/reliable_autonomous_agents.md"
+          - OmniAgent: "examples/omni_agent.md"
+      - 2O+ Autonomous Agent Blogs: "examples/ideas.md"
+  - Applications:
+      - CustomerSupport:
+          - Overview: "applications/customer_support.md"
+      - Marketing:
+          - Overview: "applications/marketing_agencies.md"
+  - Corporate:
+      - FAQ: "corporate/faq.md"
+      - Purpose: "corporate/purpose.md"
+      - Roadmap: "corporate/roadmap.md"
+      - Weaknesses: "corporate/failures.md"
+      - Design: "corporate/design.md"
+      - Flywheel: "corporate/flywheel.md"
+      - Bounties: "corporate/bounties.md"
+      - Metric: "corporate/metric.md"
+      - Distribution: "corporate/distribution"
+      - Research: "corporate/research.md"
+      - Demos: "corporate/demos.md"
+      - Architecture: "corporate/architecture.md"
+      - Checklist: "corporate/checklist.md"
+      - Hiring: "corporate/hiring.md"
+      - SwarmCloud: "corporate/swarm_cloud.md"