mkdocs.yml

site_name: PyTao
repo_url: https://github.com/bmad-sim/pytao
repo_name: Bmad-Sim/PyTao

nav:
  - Home: index.md

  - Installation: installation.md

  - Usage: usage.md

  - Examples:
      - examples/basic.ipynb
      - examples/plot-matplotlib.ipynb
      - examples/plot-bokeh.ipynb
      - examples/plot-bokeh-vars.ipynb
      - examples/bunch.ipynb
      - examples/special_parsers.ipynb
      - examples/fodo.ipynb
      - examples/advanced.ipynb

  - Dev:
      - development.md

  - API:
      - Tao: api/tao.md
      - SubprocessTao: api/subprocesstao.md
      - Plotting: api/plot.md
      - Matplotlib: api/plot-mpl.md
      - Bokeh: api/plot-bokeh.md

theme:
  icon:
    repo: fontawesome/brands/github
  name: material

  custom_dir: docs/overrides
  features:
    - navigation.top
    - navigation.tabs
    - navigation.indexes
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: black
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode

markdown_extensions:
  - pymdownx.highlight
  - pymdownx.superfences

extra:
  generator: false
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/bmad-sim/pytao
      name: PyTao

extra_css:
  - stylesheets/extra.css

plugins:
  - search

  - mkdocs-jupyter:
      include_source: True

  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            filters:
              - "!^_" # exclude all members starting with _
              - "^__init__$" # but always include __init__ modules and methods
            docstring_style: numpy
            docstring_options:
              ignore_init_summary: false
            heading_level: 3
            show_root_heading: true
            show_root_toc_entry: true
            show_root_full_path: true
            show_root_members_full_path: false
            show_object_full_path: true
            show_category_heading: true
            show_if_no_docstring: false
            show_signature: true
            signature_crossrefs: true
            show_signature_annotations: false
            separate_signature: true
            line_length: 100
            merge_init_into_class: true
            show_source: true
            show_bases: true
            show_submodules: false
            group_by_category: true
            unwrap_annotated: true
            import:
              - https://docs.python.org/3/objects.inv
          rendering:
            show_source: true
            show_root_heading: true