pyargos/mkdocs.yml at master · KaplanOpenSource/pyargos · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
site_name: pyArgos Documentation
site_description: Documentation for the pyArgos IoT experiment management platform
site_url: https://argosp.github.io/pyargos/
repo_url: https://github.com/argosp/pyargos
repo_name: argosp/pyargos

theme:
  name: material
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.instant
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
  palette:
    - scheme: default
      primary: indigo
      accent: teal
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: teal
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  icon:
    repo: fontawesome/brands/github

plugins:
  - search
  - mkdocstrings:
      enabled: true
      default_handler: python
      handlers:
        python:
          paths:
            - .
          options:
            show_source: true
            show_root_heading: true
            heading_level: 3
            docstring_style: numpy
            show_signature_annotations: true
            members_order: source
            allow_inspection: true

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - attr_list
  - md_in_html
  - toc:
      permalink: true

nav:
  - Home: index.md
  - User Guide:
      - Overview: user_guide/index.md
      - Installation & Setup: user_guide/installation.md
      - Key Concepts: user_guide/concepts.md
      - Experiment Setup: user_guide/experiment_setup.md
      - Kafka Integration: user_guide/kafka.md
      - ThingsBoard Integration: user_guide/thingsboard.md
      - Node-RED Integration: user_guide/nodered.md
      - Testing & Mock Devices: user_guide/testing.md
      - CLI Reference: user_guide/cli.md
      - Configuration Reference: user_guide/configuration.md
      - Troubleshooting: user_guide/troubleshooting.md
  - Developer Guide:
      - Overview: developer_guide/index.md
      - Data Model Reference: developer_guide/data_model.md
      - Experiment Setup:
          - Overview: developer_guide/experiment_setup_index.md
          - Architecture: developer_guide/architecture/experiment_setup.md
          - API Reference: developer_guide/api/experiment_setup.md
      - Architecture:
          - Core Concepts: developer_guide/architecture/core_concepts.md
          - Data Flow: developer_guide/architecture/data_flow.md
      - API Reference:
          - Overview: developer_guide/api/index.md
          - Experiment Manager: developer_guide/api/manager.md
          - Kafka Consumer: developer_guide/api/kafka.md
          - Node-RED: developer_guide/api/nodered.md
          - NoSQL (Cassandra & MongoDB): developer_guide/api/nosql.md
          - Utilities: developer_guide/api/utils.md
      - Changelog: changelog.md