python-project-template/mkdocs.yml at main · amrabed/python-project-template · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
site_name: Project Documentation
repo_url: https://github.com/amrabed/python-project-template
repo_name: amrabed/python-project-template
edit_uri: edit/main/docs/
# copyright: Copyright &copy; 2024

theme:
  name: material
  features:
  - announce.dismiss
  - content.action.edit
  - content.action.view
  - content.code.annotate
  - content.code.copy
  - content.tooltips
  - navigation.footer
  - navigation.indexes
  - navigation.sections
  - navigation.tabs
  - navigation.tabs.sticky
  - navigation.top
  - search.highlight
  - search.suggest
  - toc.follow

nav:
  - Overview:
    - Overview: README.md
    - Contributing: CONTRIBUTING.md
  - Reference:
    - App: reference/app.md

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google  # Or numpy, reST, etc., based on your code style