mkdocs.yml

# mkdocs.yml
theme:
  name: "readthedocs"
  icon:
    repo: fontawesome/brands/gitlab
  features:
    - content.code.annotate
    - navigation.tabs
    - toc.follow
  analytics:
    - gtag: G-PD85X2X108
  custom_dir: doc/custom_theme

plugins:
- search
- gen-files:
    scripts:
    - doc/gen_ref_pages.py
- mkdocstrings:
    watch:
    - pyotb/
- literate-nav:
    nav_file: SUMMARY.md
- section-index
- mermaid2

nav:
- Home: index.md
- Get Started:
  - Installation of pyotb: installation.md
  - How to use pyotb: quickstart.md
  - Useful features: features.md
  - Functions: functions.md
  - Interaction with Python libraries (numpy, rasterio, tensorflow): interaction.md
- Examples:
    - Pleiades data processing: examples/pleiades.md
    - Nodata mean: examples/nodata_mean.md
- Advanced use:
    - Comparison between pyotb and OTB native library: comparison_otb.md
    - OTB versions: otb_versions.md
    - Managing loggers: managing_loggers.md
    - Troubleshooting & limitations: troubleshooting.md
- API:
  - pyotb:
      - core: reference/pyotb/core.md
      - apps: reference/pyotb/apps.md
      - functions: reference/pyotb/functions.md
      - helpers: reference/pyotb/helpers.md

# Customization
extra:
  feature:
    tabs: true
  social:
    - icon: fontawesome/brands/gitlab
      link: https://forgemia.inra.fr/orfeo-toolbox/pyotb
extra_css:
  - https://gitlab.orfeo-toolbox.org/orfeotoolbox/otb/-/raw/8.1.2-rc1/Documentation/Cookbook/_static/css/otb_theme.css
  - extra.css
use_directory_urls: false  # this creates some pyotb/core.html pages instead of pyotb/core/index.html

markdown_extensions:
  - admonition
  - toc:
      permalink: true
      title: On this page
      toc_depth: 1-2
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.details
  - pymdownx.superfences:
     custom_fences:
       - name: python
         class: python
         format: !!python/name:pymdownx.superfences.fence_code_format

# Rest of the navigation.
site_name: "pyotb: Orfeo ToolBox for Python"
repo_url: https://forgemia.inra.fr/orfeo-toolbox/pyotb
repo_name: pyotb
docs_dir: doc/