mkdocs.yml

site_name: Turtle Canon
site_description: Documentation for the Turtle Canon tool
site_url: https://casperwa.github.io/turtle-canon
copyright: Copyright © 2021 Casper Welzel Andersen & SINTEF

theme:
  name: material
  palette:
    scheme: default
    primary: deep purple
    accent: deep orange
  icon:
    repo: fontawesome/brands/github
  logo:
  favicon:
  language: en
  features:
    - navigation.instant
    - navigation.top

repo_name: turtle-canon
repo_url: https://github.com/CasperWA/turtle-canon
edit_uri: ""

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/CasperWA
      name: CasperWA on GitHub
  version:
    provider: mike
    default: latest

extra_css:
  - css/reference.css

markdown_extensions:
  - admonition
  - pymdownx.highlight
  - pymdownx.superfences
  - pymdownx.inlinehilite
  - pymdownx.tabbed
  - pymdownx.caret
  - pymdownx.tilde
  - toc:
      permalink: true

plugins:
  - search:
      lang: en
  - minify:
      minify_html: true
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            show_root_heading: false
            show_root_toc_entry: true
            show_root_full_path: true
            show_object_full_path: false
            show_category_heading: false
            show_if_no_docstring: false
            show_source: true
            group_by_category: true
            heading_level: 2
            filters:
              - "!^_[^_]"
              - "!__json_encoder__$"
              - "!__all__$"
              - "!__config__$"
            members: null
            inherited_members: false
            docstring_style: google
            docstring_options:
              replace_admonitions: true
  - awesome-pages

watch:
  - turtle_canon