loggext-py/mkdocs.yml at main · utility-libraries/loggext-py · 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
site_name: loggext.py
site_description: logging extensions for pythons logging library
site_url: https://utility-libraries.github.io/loggext-py/
repo_url: https://github.com/utility-libraries/loggext-py
repo_name: utility-libraries/loggext-py
copyright: Copyright &copy; 2024, utility-libraries
nav:
  - Home:
      - loggext: index.md
      - Installation: installation.md
      - Usage:
          - loggext.decorators: usage/decorators.md
          - loggext.extradata: usage/extradata.md
          - loggext.formatting: usage/formatting.md
          - loggext.handlers: usage/handlers.md
          - loggext.utility: usage/utility.md
      - Abbreviations: abbreviations.md
  - Code Reference: reference/
theme:
  name: material
  icon:
    repo: fontawesome/brands/github
  features:
    - navigation.instant
    - navigation.instant.progress
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
#    - navigation.sections
    - navigation.expand
#    - navigation.indexes
    - toc.follow
    - navigation.top
    - search.suggest
    - search.highlight
#    - search.share
    - navigation.footer
    - content.code.copy
    - content.code.annotate
    - content.tooltips
    - content.tabs.link
plugins:
  - autorefs
  - search
  - tags
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: sphinx
          paths:
            - src
  - gen-files:
      scripts:
        - scripts/gen_ref_pages.py
  - literate-nav:
      nav_file: SUMMARY.md
  - section-index
use_directory_urls: true
watch:
  - src/loggext/
#extra:
#  version:
#    provider: mike
markdown_extensions:
  - abbr
  - admonition
  - codehilite
  - attr_list
  - def_list
  - toc:
      permalink: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.snippets:
      auto_append:
        - docs/includes/abbreviations.md
  - def_list
  - pymdownx.tasklist:
      custom_checkbox: true