comcheckweb-api-python/mkdocs.yml at main · pnnl/comcheckweb-api-python · 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
site_name: COMcheck API — Python Package
site_description: Type-safe Python client for the PNNL COMcheck Web API
site_url: https://pnnl.github.io/comcheckweb-api-python/
repo_url: https://github.com/pnnl/comcheckweb-api-python
docs_dir: docs_site

theme:
  name: material
  palette:
    - scheme: default
      primary: blue
      accent: light blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: blue
      accent: light blue
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.highlight
    - content.code.copy

plugins:
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            show_root_full_path: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            members_order: source
            merge_init_into_class: true
            show_if_no_docstring: false
            signature_crossrefs: true
            separate_signature: true

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - Types Guide: types-guide.md
  - COMcheckClient: api/client.md
  - Simulation: api/simulation.md
  - Project Operations:
      - Building Area: api/operations/building-area.md
      - Envelope: api/operations/envelope.md
      - Interior Lighting: api/operations/interior-lighting.md
      - Exterior Lighting: api/operations/exterior-lighting.md
      - Mechanical: api/operations/mechanical.md
      - Credits: api/operations/credits.md
      - Renewable Energy: api/operations/renewable-energy.md
  - Project Defaults: api/defaults.md
  - Introspection & Validation: api/introspection.md