mkdocs.yml

site_name: osm-rawdata
site_description: Make data extracts from OSM data.
# strict: true
site_url: "https://www.hotosm.org"

repo_name: "hotosm/osm-rawdata"
repo_url: "https://github.com/hotosm/osm-rawdata/"
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

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.md
      - License: LICENSE.md
      - Changelog: CHANGELOG.md
      - Code of Conduct: https://docs.hotosm.org/code-of-conduct
      - Versioning: https://docs.hotosm.org/dev-guide/repo-management/version-control/#creating-releases
  - Utilities:
      - Importer: importer.md
      - Postgres: postgres.md
      - Geofabrik: geofabrik.md
      - Overture: overture.md
  - File Formats:
      - JSON: json.md
      - YAML: yaml.md
      - Overture: overture.md
  - API: api.md