dcmspec/mkdocs.yml at main · dwikler/dcmspec · 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
site_name: DCMspec Documentation

# NOTE: The API Reference section uses logical ordering (by functional area and workflow)
# rather than alphabetical order. This is to help users find related concepts together
# and to reflect the typical usage flow of the library.
nav:
  - Home: index.md
  - Installation: installation.md
  - Release Notes: changelog.md
  - Configuration & Caching: configuration.md
  - CLI Applications:
      - CLI Apps Overview: apps/cli/index.md
      - modattributes: apps/cli/modattributes.md
      - iodattributes: apps/cli/iodattributes.md
      - iodmodules: apps/cli/iodmodules.md
      - dataelements: apps/cli/dataelements.md
      - uidvalues: apps/cli/uidvalues.md
      - upsdimseattributes: apps/cli/upsdimseattributes.md
      - upsioddimseattributes: apps/cli/upsioddimseattributes.md
      - tdwiicontent: apps/cli/tdwiicontent.md

  - UI Applications:
      - UI Apps Overview: apps/ui/index.md
      - IOD Explorer: apps/ui/iod-explorer.md

  - API Reference:
      - API Overview: api/index.md
      - Constants Modules:
          - Service Attribute Defaults: api/service_attribute_defaults.md
      - Core Classes:
          - SpecModel: api/spec_model.md
          - SpecMerger: api/spec_merger.md
          - ServiceAttributeModel: api/service_attribute_model.md
          - SpecFactory: api/spec_factory.md
          - IODSpecBuilder: api/iod_spec_builder.md
          - ModuleRegistry: api/module_registry.md
      - Parse Classes:
          - SpecParser: api/spec_parser.md
          - DOMTableSpecParser: api/dom_table_spec_parser.md
          - CSVTableSpecParser: api/csv_table_spec_parser.md
      - Load Classes:
          - DocHandler: api/doc_handler.md
          - XHTMLDocHandler: api/xhtml_doc_handler.md
          - UPSXHTMLDocHandler: api/ups_xhtml_doc_handler.md
          - PDFDocHandler: api/pdf_doc_handler.md
      - Store Classes:
          - SpecStore: api/spec_store.md
          - JSONSpecStore: api/json_spec_store.md
      - Print Classes:
          - SpecPrinter: api/spec_printer.md
          - IODSpecPrinter: api/iod_spec_printer.md
      - Utils Classes:
          - Config: api/config.md
          - DOMUtils: api/dom_utils.md
          - Progress: api/progress.md

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            docstring_style: google
            docstring_section_style: spacy
            show_root_heading: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true

theme:
  name: material
  logo: images/dcmspec_logo_100.png
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: blue
      accent: teal
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: cyan
      accent: yellow
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode

markdown_extensions:
  - pymdownx.highlight
  - pymdownx.superfences
  - def_list
  - pymdownx.snippets

extra_css:
  - css/mkdocstrings.css