mkdocs.yml

site_name: project_name
docs_dir: docs/docs
nav:
- Getting Started:
  - Package Overview: 'getting_started/overview.md'
  - Installation: 'getting_started/installation.md'
  - Basic Usage: 'getting_started/basic_usage.md'
  - Contributing: 'getting_started/contributing.md'
# - User Guide:
- API Reference: reference/
extra_css:
- css/code_select.css
theme:
  name: material
  repo_url: 'https://github.com/Paul-B98/python-project-template'
  features:
    - navigation.tabs
    - navigation.footer
extra:
  social:
  - icon: fontawesome/brands/github
    link: https://github.com/Paul-B98/python-project-template
  - icon: fontawesome/brands/python
    link: https://pypi.org/project/ # TODO change this to your project name
copyright: Copyright © 2023 AIDH-MS

markdown_extensions:
- attr_list
- pymdownx.highlight:
    linenums: true
    use_pygments: true
    pygments_lang_class: true
- pymdownx.superfences
- pymdownx.extra
- footnotes

plugins:
- search:
- macros:
    include_dir: ./
- gen-files:
    scripts:
      - docs/scripts/gen_ref_pages.py
- literate-nav:
    nav_file: SUMMARY.md
- section-index
- mkdocstrings:
    handlers:
      python:
        paths: ['project_name']
        options:
          docstring_style: numpy