mkdocs.yml

site_name: HYDROLIB documentation
theme:
  name: material
  language: en
  logo: images/HYDROLIB_logo_notext_mono_eroded.svg
  palette:
    - scheme: deltares
      toggle:
        icon: material/lightbulb-outline
        name: Switch to dark mode
    - scheme: slate
      toggle:
        icon: material/lightbulb
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.indexes
    - navigation.tracking
    - navigation.tabs
    - navigation.top
    - toc.integrate
plugins:
  - search
  - mkdocs-jupyter
  - autorefs
  - monorepo
  - macros:
      module_name: docs/include/mkdocs-macros/main
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          rendering:
            show_root_toc_entry: false
            show_root_heading: false
            show_source: true
            show_if_no_docstring: false
            show_signature_annotations: true
            heading_level: 3
            show_category_heading: false
            group_by_category: false
          selection:
            inherited_members: false

      custom_templates: templates
      watch:
        - hydrolib
markdown_extensions:
  - pymdownx.highlight
  - tables
  - pymdownx.superfences
  - def_list
  - pymdownx.tasklist:
      custom_checkbox: true
  - admonition
  - toc:
      permalink: true
repo_url: https://github.com/Deltares/HYDROLIB
repo_name: deltares/HYDROLIB
edit_uri: edit/main/docs/
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/Deltares/HYDROLIB
      name: Source code
    - icon: fontawesome/brands/gitter
      link: https://gitter.im/Deltares/HYDROLIB
      name: Chat with us on Gitter
copyright: Copyright © 2022 Deltares
extra_css:
  - stylesheets/extra.css

nav:
  - Home: "index.md"
  - About:
      - HYDROLIB: "about/about_HYDROLIB.md"
      - Partners: "about/about_partners.md"
  - How-to: 
      - Installation: "guides/setup.md"
      - Contributing: "guides/contributing.md"
      - Documentation: "guides/documentation.md"
  - Tools:
      - D-HyDAMO plugin: "!include ./hydrolib/dhydamo/mkdocs.yml"
      - Profile Optimizer: "!include ./hydrolib/profile_optimizer/mkdocs.yml"
      - Inundation Toolbox: "!include ./hydrolib/inundation_toolbox/mkdocs.yml"
      - Case Management Tools: "!include ./hydrolib/case_management_tools/mkdocs.yml"
      - ARCADIS Tools: "!include ./hydrolib/arcadis/mkdocs.yml"
  - Reference: 
          - "reference/api.md"
  - Changelog: 
          - "changelog.md"