mkdocs.yml

# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json

site_name: libpointmatcher
repo_url: https://github.com/norlab-ulaval/libpointmatcher
edit_uri: edit/master/doc
site_description: "An Iterative Closest Point library for 2D/3D mapping in robotics"
docs_dir: 'doc'
theme:
  name: material
  logo: images/logo.png
  favicon: images/logo.png
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: black
      accent: amber
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: amber
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

  features:
    - navigation.footer
    - navigation.tabs.sticky
    - navigation.top
    - content.tabs
    - content.code.copy
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/norlab-ulaval/libpointmatcher
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/norlab/
    - icon: fontawesome/solid/globe
      link: https://norlab.ulaval.ca
markdown_extensions:
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.details
  - attr_list
  - md_in_html
nav:
- Home: 'index.md'
- Compilation: 'Compilation.md'
- Beginner:
    - 'What can I do with libpointmatcher': 'ApplicationsAndPub.md'
    - 'What the different data filters do?': 'DataFilters.md'
    - 'Example: applying a chain of data filters': 'ApplyingDataFilters.md'
    - 'What are the different outlier filters?' : 'OutlierFiltersFamilies.md'
    - 'Example: An introduction to ICP': 'ICPIntro.md'
    - 'The ICP chain configuration and its variants': 'DefaultICPConfig.md'
    - 'Configuring libpointmatcher using YAML': 'Configuration.md'
    - 'Supported file types and importing/exporting point clouds': 'ImportExport.md'
- Advanced:
    - 'How to link a project to libpointmatcher': 'LinkingProjects.md'
    - 'How to use libpointmatcher in ROS?': 'UsingInRos.md'
    - 'How are point clouds represented?': 'PointClouds.md'
    - 'Example: Writing a program which performs ICP': 'BasicRegistration.md'
    - 'How to move a point cloud using a rigid transformation?': 'Transformations.md'
    - 'Example: Configure an ICP solution without yaml': 'ICPWithoutYaml.md'
- Developer:
    - 'Creating a DataPointsFilter': 'DataPointsFilterDev.md'
    - 'Creating a Transformation': 'TransformationDev.md'
    - 'Creating unit tests': 'UnitTestDev.md'
    - 'Contribution': 'contributing/contributing_instructions.md'
    - 'Best practices': 'contributing/commit_msg_reference.md'
- Python:
    - 'Compiling libpointmatcher with Python': 'CompilationPython.md'
    - 'Using libpointmatcher with Python': 'PythonModule.md'