mkdocs.yml

site_name: Sample Project

repo_url: https://github.com/jannismain/python-project-template-example
repo_name: python-project-template-example
site_url: https://jannismain.github.io/python-project-template-example
edit_uri: -/edit/main/docs/

theme:
  name: material

plugins:
  - search
  - git-revision-date-localized: # https://timvink.github.io/mkdocs-git-revision-date-localized-plugin
      type: timeago
      fallback_to_build_date: true
  - mkdocstrings: # see https://mkdocstrings.github.io/
      default_handler: python
      enable_inventory: true
      handlers:
        python:
          paths: [src]
          options:
            show_root_heading: true
            show_category_heading: false
            show_submodules: true
          import:
            - https://numpy.org/doc/stable/objects.inv
  - macros: # see https://mkdocs-macros-plugin.readthedocs.io/
      include_dir: .
      module_name: docs/macros