mkdocs.yml

site_name: "XLRON - Accelerated Learning and Resource Allocation for Optical Networks"
site_url: https://micdoh.github.io/XLRON/
theme:
    name: material
    logo: images/xlron_nobackground.png
    palette:
      accent: green
      primary: yellow
    features:
      - content.tabs.link
      - search.suggest
markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - attr_list
  - md_in_html
plugins:
  - search
  - mkdocstrings:
      enabled: true
      default_handler: python
      handlers:
        python:
          paths: [xlron]
          setup_commands:
            - import sys
          options:
            show_source: true
            show_root_heading: false
nav:
    - Home: 'index.md'
    - Getting Started:
      - Installation: 'installation.md'
      - Quick Start: 'quickstart.md'
    - 'User Guide':
      - Understanding XLRON: 'understanding_xlron.md'
      - Command-line options: 'flags_reference.md'
      - Function reference: 'reference.md'
    - About:
      - 'License and Support': 'license.md'
      - 'Change Log': 'changelog.md'
not_in_nav: |
  /example_sweep_config.yml