DeepCritical/mkdocs.local.yml at dev · jQuinRivero/DeepCritical · 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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
# Local development configuration
# Use this for local development: mkdocs serve -f mkdocs.local.yml

site_name: DeepCritical
site_description: Hydra-configured, Pydantic Graph-based deep research workflow
site_author: DeepCritical Team
site_url: http://localhost:8001  # Local development URL
site_dir: site

repo_name: DeepCritical/DeepCritical
repo_url: https://github.com/DeepCritical/DeepCritical
edit_uri: edit/main/docs/

theme:
  name: material
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep purple
      accent: purple
      toggle:
        icon: material/brightness-4
        name: Switch to system preference

  features:
    - announce.dismiss
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    - content.code.select
    - content.footnote.tooltips
    - content.tabs.link
    - content.tooltips
    - header.autohide
    - navigation.expand
    - navigation.footer
    - navigation.indexes
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.instant.progress
    - navigation.prune
    - navigation.sections
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
    - toc.integrate

  icon:
    repo: fontawesome/brands/github
    edit: material/pencil
    view: material/eye

  font:
    text: Roboto
    code: Roboto Mono

plugins:
  - search:
      lang: en
  - mermaid2:
      arguments:
        theme: base
        themeVariables:
          primaryColor: '#7c4dff'
          primaryTextColor: '#fff'
          primaryBorderColor: '#7c4dff'
          lineColor: '#7c4dff'
          secondaryColor: '#f8f9fa'
          tertiaryColor: '#fff'
  - git-revision-date-localized:
      enable_creation_date: true
      enable_modification_date: true
      type: timeago
      timezone: UTC
      locale: en
      fallback_to_build_date: true
  - minify:
      minify_html: true
  - mkdocstrings:
      handlers:
        python:
          paths: [., DeepResearch]
          options:
            docstring_style: google
            docstring_section_style: table
            heading_level: 1
            inherited_members: true
            merge_init_into_class: true
            separate_signature: true
            show_bases: true
            show_category_heading: true
            show_docstring_attributes: true
            show_docstring_functions: true
            show_docstring_classes: true
            show_docstring_modules: true
            show_if_no_docstring: true
            show_inheritance_diagram: true
            show_labels: true
            show_object_full_path: false
            show_signature: true
            show_signature_annotations: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            signature_crossrefs: true
            summary: true
            use_autosummary: true

nav:
  - Home: index.md
  - Getting Started:
    - Installation: getting-started/installation.md
    - Quick Start: getting-started/quickstart.md
    - Configuration: getting-started/configuration.md
  - User Guide:
    - Architecture Overview: architecture/overview.md
    - Configuration: user-guide/configuration.md
    - Flows:
      - PRIME Flow: user-guide/flows/prime.md
      - Bioinformatics Flow: user-guide/flows/bioinformatics.md
      - DeepSearch Flow: user-guide/flows/deepsearch.md
      - Challenge Flow: user-guide/flows/challenge.md
    - Tools:
      - Tool Registry: user-guide/tools/registry.md
      - Bioinformatics Tools: user-guide/tools/bioinformatics.md
      - Search Tools: user-guide/tools/search.md
      - RAG Tools: user-guide/tools/rag.md
  - API Reference:
    - Core Modules: core/index.md
    - Utilities: utilities/index.md
    - Flows: flows/index.md
    - Tools: api/tools.md
    - Tool Overview: tools/index.md
  - Development:
    - Setup: development/setup.md
    - Contributing: development/contributing.md
    - Testing: development/testing.md
    - CI/CD: development/ci-cd.md
    - Scripts: development/scripts.md
  - Examples:
    - Basic Usage: examples/basic.md
    - Advanced Workflows: examples/advanced.md