mkdocs.yml

site_name: Pydre documentation

theme:
  name: material
  font:
    text: BuckeyeSans
  palette:
    scheme: OSU
extra_css:
  - stylesheets/extra.css

plugins:
- mkdocstrings:
    default_handler: python
    handlers:
      python:
        options:
          show_root_heading: false
          show_source: false
          separate_signature: true
          line_length: 100
          show_signature_annotations: true
          signature_crossrefs: true


remote_name: GitHub

markdown_extensions:
  - admonition
  - footnotes
  - pymdownx.details
  - pymdownx.superfences

nav:
  - Home: 'index.md'
  - Tutorial:
      - Getting Started: 'tutorial/getting_started.md'
  - Reference:
    - Filter definitions: 'reference/filters.md'
    - Metric definitions: 'reference/metrics.md'
    - SAE Standards: 'reference/metricStandards.md'
  - Explanation:
    - Project files: 'explanation/project_files.md'
    - Regions of Interest: 'explanation/rois.md'
    - Developer Notes: 'explanation/developernotes.md'