mkdocs.yml

site_name: osm-fieldwork
site_description: Processing data from ODK to OpenStreetMap format, and other field data collection utils.
# strict: true
site_url: "https://www.hotosm.org"

repo_name: "hotosm/osm-fieldwork"
repo_url: "https://github.com/hotosm/osm-fieldwork/"
edit_uri: "edit/main/docs/"

extra:
  social:
    - icon: "fontawesome/brands/github"
      link: "https://github.com/hotosm/"
    - icon: "fontawesome/brands/twitter"
      link: "https://twitter.com/hotosm"
    - icon: "fontawesome/solid/globe"
      link: "https://www.hotosm.org"
  copyright: Copyright © 2010 HOTOSM
  generator: false

theme:
  name: material
  palette:
    primary: custom
  favicon: images/favicon.png
  logo: images/hot_logo.png
  # custom_dir: docs/overrides

extra_css:
  - css/extra.css

markdown_extensions:
  - tables
  - toc:
      permalink: true
      title: Page contents
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight
  - pymdownx.extra
  - pymdownx.emoji:
  - pymdownx.tabbed:
      alternate_style: true
  - mdx_truly_sane_lists

plugins:
  - search
  - git-revision-date-localized
  - exclude:
      glob:
        - plugins/*
        - __pycache__/*
  - mkdocstrings:
      handlers:
        python:
          paths: [.]
          options:
            members_order: source
            separate_signature: true
            filters: ["!^_"]
            docstring_options:
              ignore_init_summary: true
            merge_init_into_class: true

nav:
  - Home: index.md
  - Get Started:
      - About: about/About.md
      - FAQ: about/FAQ.md
      - Troubleshooting: about/Troubleshooting.md
      - Changelog: CHANGELOG.md
      - Code of Conduct: https://docs.hotosm.org/code-of-conduct
      - License: LICENSE.md
      - Versioning: https://docs.hotosm.org/dev-guide/version-control/#creating-releases
  - User Manual: about/user-manual.md
  - Core Program Usage:
      - ODK Client: about/odk_client.md
      - make_data_extract: about/make_data_extract.md
  - Utility Program Usage:
      - odk2osm: about/odk2osm.md
  - API:
      - ODK Central: api/OdkCentral.md
      - ODK Central (Async): api/OdkCentralAsync.md
      - basemapper: api/basemapper.md
      - make_data_extract: api/make_data_extract.md
      - convert: api/convert.md
      - sqlite: api/sqlite.md
      - osmfile: api/osmfile.md
      - yamlfile: api/yamlfile.md
      - ODKInstance: api/ODKInstance.md
      - ODKForm: api/ODKForm.md
      - filter_data: api/filter_data.md
      - update_xlsform: api/update_xlsform.md
  - Deep Tech Dives:
      - External Data: about/externaldata.md
      - Data conflation: about/conflation.md
      - The Config File: about/configuring.md
      - XLSForm Design: about/xlsforms.md
      - ODK Entities: about/odk-entities.md
  #  - odk2geojson: api/odk2geojson.md
  #  - odk2csv: api/odk2csv.md
  #  - odk2osm: api/odk2osm.md
  - Class Hierarchy: apidocs/html/inherits.html