tracksdata/mkdocs.yml at main · royerlab/tracksdata · 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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
site_name: tracksdata
site_url: https://royerlab.github.io/tracksdata/
repo_name: "royerlab/tracksdata"
repo_url: "https://github.com/royerlab/tracksdata"
watch: [mkdocs.yml, README.md, src]

# Version management with mike
extra:
  version:
    provider: mike
    default: latest

# maximum strictness
# https://www.mkdocs.org/user-guide/configuration/#validation
strict: true
validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn
  anchors: warn
  links:
    # Allow an absolute link to the features page for our code snippets
    absolute_links: ignore


theme:
  name: material
  icon:
    logo: material/graph
  palette:
    scheme: default
    primary: lime
    accent: deep-orange

nav:
  - Home: index.md
  - Installation: installation.md
  - Concepts: concepts.md
  - Getting Started: getting_started.md
  - Examples: examples.md
  - FAQ: faq.md
  - Contributing: contributing.md

plugins:
  - search
  - api-autonav:
      modules: ['src/tracksdata']
      on_implicit_namespace_package: skip
      exclude_private: true
      exclude:
        - "tracksdata.conftest"
  # from: https://github.com/tlambert03/mkdocs-api-autonav/tree/main
  - mkdocstrings:
      default_handler: python_xref
      handlers:
        python_xref:
          inventories:
            - https://docs.python.org/3/objects.inv
            - https://numpy.org/doc/stable/objects.inv
            - https://docs.pola.rs/api/python/stable/objects.inv
            - http://docs.sqlalchemy.org/en/stable/objects.inv
          options:
            docstring_section_style: list # or "table"
            docstring_style: "numpy"
            filters:
              - "!^_"
              - "^(?!.*_test)"
              - "!conftest"
            group_by_category: true
            heading_level: 1
            # begin python-xref
            relative_crossrefs: true
            check_crossrefs: true
            # end python-xref
            inherited_members: true
            merge_init_into_class: true
            parameter_headings: true
            separate_signature: true
            show_bases: true
            show_if_no_docstring: false
            show_root_heading: true
            show_signature_annotations: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            show_inheritance_diagram: true
            summary: true
  - mermaid2


markdown_extensions:
  - admonition
  - pymdownx.snippets:
      check_paths: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
      use_pygments: true
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - pymdownx.extra:
      pymdownx.superfences:
        custom_fences:
          - name: mermaid
            class: mermaid
            format: !!python/name:pymdownx.superfences.fence_code_format  # noqa