expiring-lru-cache/mkdocs.yml at main · datarootsio/expiring-lru-cache · 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

site_name: "expiring-lru-cache"
site_description: "Documentation for `expiring-lru-cache`."
site_url: "https://datarootsio.github.io/expiring-lru-cache"
repo_url: "https://github.com/datarootsio/expiring-lru-cache"
edit_uri: "blob/main/docs/"
repo_name: "datarootsio/expiring-lru-cache"

markdown_extensions:
  - def_list
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.snippets:
      check_paths: true
  - pymdownx.tasklist:
      custom_checkbox: true

theme:
  name: "material"
  logo: images/logo.png
  favicon: images/favicon.png
  font:
    text: arvo
    code: poppins
  icon:
    repo: fontawesome/brands/github-alt
  features:
    - navigation.top

plugins:
- search
- autorefs
- coverage
- mkdocstrings:
    watch:
      - expiring_lru_cache
    handlers:
      python:
        selection:
          docstring_style: sphinx

extra_css:
  - stylesheets/extra.css

nav:
- Home: index.md
- API: api.md
- Development:
  - Contributing: contrib.md
  - Coverage report: coverage.md

copyright: 'Maintained by dataroots'

extra:
    version:
      provider: mike
    social:
        - icon: fontawesome/brands/github-alt
          link: 'https://github.com/datarootsio'
        - icon: fontawesome/brands/linkedin
          link: 'https://www.linkedin.com/company/dataroots/'
        - icon: fontawesome/brands/instagram
          link: 'https://www.instagram.com/lifeatdataroots/'
        - icon: fontawesome/brands/youtube
          link: 'https://www.youtube.com/c/dataroots'
        - icon: fontawesome/solid/globe
          link: 'https://dataroots.io/'