dr-cli/docs/mkdocs.yml at main · cdevent/dr-cli · 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
site_name: DataRobot CLI Documentation
site_url: https://datarobot-oss.github.io/cli/dev-docs/
site_description: Documentation for the DataRobot CLI tool
repo_url: https://github.com/datarobot-oss/cli
repo_name: datarobot-oss/cli
edit_uri: edit/main/docs/

theme:
  name: material
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.indexes
    - toc.follow
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.action.edit

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - attr_list
  - md_in_html

plugins:
  - search
  - same-dir

# Output configuration
site_dir: dev-docs
docs_dir: .

# Navigation structure
nav:
  - Home: index.md
  - User guide:
      - user-guide/README.md
      - Quick reference: user-guide/quick-reference.md
      - Shell completions: user-guide/shell-completions.md
      - Configuration: user-guide/configuration.md
  - Template system:
      - template-system/README.md
      - Structure: template-system/structure.md
      - Interactive configuration: template-system/interactive-config.md
      - Environment variables: template-system/environment-variables.md
  - Commands:
      - commands/README.md
      - auth: commands/auth.md
      - start: commands/start.md
      - run: commands/run.md
      - task: commands/task.md
      - dotenv: commands/dotenv.md
      - completion: commands/completion.md
      - self: commands/self.md
      - plugins: commands/plugins.md
      - component: commands/component-managed-updates.md
  - Development:
      - development/README.md
      - Setup: development/setup.md
      - Building: development/building.md
      - Structure: development/structure.md
      - Authentication: development/authentication.md
      - Releasing: development/releasing.md
      - Plugins: development/plugins.md

# Exclude patterns to avoid processing non-documentation files
exclude_docs: |
  dev-preview/
  .venv/
  pyproject.toml
  component-defaults-example.yaml
  install
  winstall