mkdocs.yml

site_name: EMMOntoPy
site_description: Documentation for the EMMOntoPy library
site_url: https://emmo-repo.github.io/EMMOntoPy
copyright: Copyright © 2019-2022 SINTEF

theme:
  name: material
  palette:
    scheme: default
    primary: green
    accent: light green
  icon:
    repo: fontawesome/brands/github
  logo: images/emmontopy-logo.svg
  favicon: images/favicon.png
  language: en
  features:
    - navigation.instant
    - navigation.top
    - content.tabs.link

repo_name: EMMOntoPy
repo_url: https://github.com/emmo-repo/EMMOntoPy
edit_uri: ""

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

extra_css:
  - css/reference.css

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

plugins:
  - search:
      lang: en
  - 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
            show_bases: true
            group_by_category: true
            heading_level: 2
            filters:
              - "!^_"
              - "^__init__$"
            members: null
            inherited_members: false
            docstring_style: google
            docstring_options:
              replace_admonitions: true
  - awesome-pages

nav:
  - Home: index.md
  - Tools: tools-instructions.md
  - Docker: docker-instructions.md
  - License: LICENSE.md
  - Examples and demonstrations:
    - Demo:
      - demo/README.md
      - demo/horizontal/README.md
      - demo/vertical/README.md
    - Examples:
      - EMMOdoc: examples/emmodoc/README.md
      - Jupyter visualization: examples/jupyter-visualization/README.md
      - Ontology generation from Excel: examples/ontology-from-excel/README.md
  - ... | developers/**
  - Changelog: CHANGELOG.md
  - ... | api_reference/**

watch:
  - emmopy
  - ontopy