oss-taapp/mkdocs.yml at root · ivanearisty/oss-taapp · 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
40
41
42
43
44
45
46
47
48
site_name: Mail Client Project
site_description: "A professional-grade template for a modern Python project."

theme:
  name: material
  palette:
    # Light mode
    - scheme: default
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    # Dark mode
    - scheme: slate
      toggle:
        icon: material/weather-night
        name: Switch to light mode
  features:
    - navigation.tabs
    - content.code.copy

nav:
  - 'Overview': 'index.md'
  - 'Architecture': 'component.md'
  - 'API Reference':
    - 'Message Protocol': 'api/message.md'
    - 'Mail Client API': 'api/mail_client_api.md'
    - 'Gmail Client Implementation': 'api/gmail_client_impl.md'
    - 'Gmail Message Implementation': 'api/gmail_message_impl.md'

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences

plugins:
  - mkdocstrings:
      handlers:
        python:
          options:
            # This helps mkdocstrings find packages in the src directory
            search_paths:
              - src/message/src
              - src/mail_client_api/src
              - src/gmail_client_impl/src
              - src/gmail_message_impl/src
            show_source: false
            docstring_section_style: spacy
            members_order: source