boutiques_next/mkdocs.yml at main · childmindresearch/boutiques_next · 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
site_name: Boutiques
site_description: A Python toolkit for the Boutiques descriptor standard.
# Pre-merge home; will flip to boutiques/boutiques once upstreamed.
site_url: https://childmindresearch.github.io/boutiques_next/
repo_url: https://github.com/childmindresearch/boutiques_next
edit_uri: edit/main/docs/

theme:
  name: material
  logo: logo.svg
  favicon: logo.svg
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.indexes
    - navigation.top
    - content.code.copy
    - search.highlight
    - search.suggest
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

nav:
  - Home: index.md
  - Specification:
      - spec/index.md
      - Basic structure: spec/basic_structure.md
      - File handling: spec/file_handling.md
      - Subcommands: spec/subcommands.md
      - Advanced features: spec/advanced_features.md
      - Examples: spec/examples.md
      - Troubleshooting: spec/troubleshooting.md
  - CLI:
      - cli/index.md
      - validate: cli/validate.md
      - example: cli/example.md
      - exec: cli/exec.md
      - test: cli/test.md
      - pprint: cli/pprint.md
      - schema-export: cli/schema-export.md
      - invocation: cli/invocation.md
      - invocation-schema: cli/invocation-schema.md
      - version: cli/version.md
  - Python API:
      - api/index.md

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true

plugins:
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [src]
          options:
            show_root_heading: true
            show_root_full_path: false
            show_signature_annotations: true
            separate_signature: true
            line_length: 80
            docstring_style: google
            show_source: false
            members_order: source
            merge_init_into_class: true
            heading_level: 3