funtracks/mkdocs.yml at main · funkelab/funtracks · 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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
site_name: funtracks

site_url: https://funkelab.github.io/funtracks/

theme:
  name: "material"
  logo: assets/logo.svg
  favicon: assets/logo.svg
  palette:
    scheme: slate
    primary: purple
    accent: purple
  features:
    - navigation.indexes
    - content.code.copy

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - https://unpkg.com/mermaid@10/dist/mermaid.min.js

extra:
  version:
    provider: mike
    default: latest

nav:
  - Home: index.md
  - Architecture:
    - Features: features.md
    - Import: import-flow.md
  - API Reference: reference/

markdown_extensions:
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format

plugins:
- search
- mkdocstrings:
    handlers:
      python:
        import:
          - https://docs.python.org/3/objects.inv
        options:
          docstring_section_style: table # list # or "table"
          docstring_style: "google"
          heading_level: 3
          merge_init_into_class: true
          # parameter_headings: true
          separate_signature: true
          show_root_heading: true
          show_source: false
          show_signature_annotations: true
          show_symbol_type_heading: true
          show_symbol_type_toc: true
          # summary: true
          show_docstring_attributes: true
          show_attribute_values: true
          show_labels: false
- api-autonav:
    modules: ['src/funtracks/']