cachium/mkdocs.yml at master · zoola969/cachium · 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
# mkdocs.yml
site_name: cachium
site_description: Sync and async cache for your Python applications.
site_url: https://zoola969.github.io/cachium
repo_url: https://github.com/zoola969/cachium
repo_name: https://github.com/zoola969/cachium
edit_uri: edit/main/

theme:
  name: material
  palette:
    primary: indigo
    accent: indigo
  icon:
    repo: fontawesome/brands/github
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.expand
    - navigation.indexes
    - navigation.top
    - search.highlight
    - content.code.copy

nav:
  - Home: index.md
  - Installation: installation.md
  - Guides:
    - Quickstart: guides/quickstart.md
    - Concepts: guides/concepts.md
    - Tutorials: guides/tutorials.md
  - API Reference:
    - Overview: api/index.md
    - Cache: api/cache.md
    - Builders: api/builders.md
    - Serializers: api/serializers.md
    - Storages: api/storages.md
    - Utilities: api/utilities.md
  - Examples: examples.md
  - Changelog: changelog.md
  - Contributing: contributing.md

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - admonition
  - footnotes
  - attr_list
  - md_in_html
  - toc:
      permalink: true

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: true
            heading_level: 3
            show_category_heading: true
            show_signature_annotations: true
            merge_init_into_class: true
            members_order: source
            signature_crossrefs: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            show_root_heading: true
            show_if_no_docstring: true
            filters: ["!^_[^_]"]            # Exclude private members (starting with single _)
watch:
  - cachium/
  - docs/