mkdocs.yml

site_name: BuildingsBench
site_description: The documentation for the BuildingsBench platform.
site_author: Patrick Emami
site_url: https://nrel.github.io/BuildingsBench

repo_name: NREL/BuildingsBench
repo_url: https://github.com/NREL/BuildingsBench/

theme:
  name: material
  features:
      - navigation.sections  # Sections are included in the navigation on the left.
      - toc.integrate  # Table of contents is integrated on the left; does not appear separately on the right.
      - header.autohide  # header disappears as you scroll
  palette:
      - scheme: default
        primary: white
        accent: amber
        toggle:
            icon: material/weather-night
            name: Switch to dark mode
      - scheme: slate
        primary: black
        accent: amber
        toggle:
            icon: material/weather-sunny
            name: Switch to light mode
plugins:
  - search
  - autorefs  # Cross-links to headings
  - mkdocstrings:
      handlers:
          python:
            selection:
                inherited_members: true  # Allow looking up inherited methods
            rendering:
                show_root_heading: true  # actually display anything at all...
                show_root_full_path: true  # display "diffrax.asdf" not just "asdf"
                show_signature_annotations: true
                show_source: false  # don't include source code
                members_order: source  # order methods according to their order of definition in the source code, not alphabetical order
                heading_level: 4    

nav: 
  - Home: index.md
  - Getting Started: getting_started.md
  - Running the Benchmark: running.md
  - Tutorials: tutorials.md
  - API: 
    - Data:
      - API/data/buildings_bench-data.md
    - Models:
      - API/models/buildings_bench-models.md
    - Utilities:
      - API/utilities/buildings_bench-evaluation.md
      - API/utilities/buildings_bench-tokenizer.md
      - API/utilities/buildings_bench-transforms.md
      - API/utilities/buildings_bench-utils.md

extra_css:
    - css/extra.css
    - css/github-permalink-style.css

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - toc:
      permalink: ''
      toc_depth: 1-2