Kataglyphis-Inference-Engine/dartdoc_options.yaml at develop · Kataglyphis/Kataglyphis-Inference-Engine · 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
# “additional-docs” tells Dartdoc: “Here are extra markdown files to render
#  as top-level pages in the generated doc site.” Each entry is a path
#  (relative to the project root).
dartdoc:
  ignore:
    - ambiguous-reexport
    - unresolved-doc-reference
  autoIncludeDependencies: false
  linkToRemote: false
  categories:
    overview:
      markdown: docs/INTRODUCTION.md
      displayName: Start Here
    guides:
      markdown: docs/source/overview.md
      displayName: Core Guides
    readmes:
      markdown: docs/source/readmes.md
      displayName: Readmes
    operations:
      markdown: docs/source/project-operations.md
      displayName: Operations
  categoryOrder: [overview, guides, readmes, operations]
  showUndocumentedCategories: true
  additional-docs:
    - README.md
    - docs/INTRODUCTION.md
    - docs/source/README.md
    - docs/source/overview.md
    - docs/source/getting-started.md
    - docs/source/platforms.md
    - docs/source/camera-streaming.md
    - docs/source/readmes.md
    - docs/source/project-operations.md
    - docs/source/roadmap.md
    - docs/source/upgrade-guide.md
    - rust_builder/README.md
    - scripts/ai/README.md
    - assets/documents/README.md