trendify/mkdocs.yml at main · TalbotKnighton/trendify · 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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
site_name: Trendify
site_url: https://talbotknighton.github.io/trendify/
repo_url: https://github.com/TalbotKnighton/trendify
repo_name: TalbotKnighton/trendify
site_description: Data visualization for batch processes via data models.
site_author: Talbot Knighton

# edit_uri: blob/master/docs/

theme:
  name: material
  logo: assets/logo_pink_white_bg.svg
  favicon: assets/logo_pink_white_bg.svg
  features:
    # - header.autohide
    - search.suggest
    - search.highlight
    - navigation.tabs
    - navigation.top
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.tracking
    # - navigation.indexes
    - content.tabs
    - content.tabs.link
    - content.code.annotation
    - content.code.copy
    - content.tooltips
    # - toc.integrate
  color_mode: auto
  user_color_mode_toggle: true
  language: en
  palette:
    - scheme: default
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
      primary: pink
      accent: blue
    - scheme: slate
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode
      primary: pink
      accent: blue
  highlightjs: true
  hljs_languages:
    - yaml
    - django

nav:
  - Welcome: index.md
  - Motivation: motivation.md
  - Examples:
      - Basic: example.md
      - More: more_examples.md
  - Recipe: recipe.md
  - API and CLI: api_and_cli.md
  - Code Reference: reference/
  - Planned Features: planned_features.md

# Add the extra section here
extra:
  # Add your custom configurations or variables
  disable_ssl_certificate_validation: true

extra_css:
  - css/code_select.css
  - css/mkdocstrings.css
  - css/logo.css

# exclude_docs: |
#   *.py

markdown_extensions:
  - toc:
      permalink: true
  - admonition
  - codehilite
  - toc:
      permalink: true
      title: On this page
  - attr_list
  - def_list
  - tables
  - pymdownx.highlight:
      use_pygments: false
      pygments_lang_class: true
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - callouts
  - mdx_gh_links:
      user: mkdocs
      repo: mkdocs
  - mkdocs-click
  #
  - pymdownx.snippets:
      base_path: "docs/"
      auto_append:
        - includes/abbreviations.md
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - abbr
  - attr_list
  - md_in_html
  - def_list
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.tasklist:
      custom_checkbox: true
      clickable_checkbox: false
  - admonition
  - pymdownx.arithmatex:
      generic: true
  - footnotes
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.mark
  - markdown_include.include:
      base_path: docs

copyright: Copyright &copy; 2024 <a href="https://github.com/TalbotKnighton">Talbot Knighton</a>, Maintained by the <a href="https://github.com/TalbotKnighton">Talbot Knighton</a>.

hooks:
  - docs/hooks.py

plugins:
  # - git-revision-date-localized:
  #     enable_creation_date: true
  - search
  - glightbox
  - gen-files:
      scripts:
        - scripts/gen_ref_pages.py
  - section-index
  - autorefs
  - literate-nav:
      nav_file: SUMMARY.md
      implicit_index: true
  - mkdocstrings:
      handlers:
        python:
          import:
            # https://stackoverflow.com/questions/52805115/certificate-verify-failed-unable-to-get-local-issuer-certificate
            - https://docs.python.org/3/objects.inv
            - https://matplotlib.org/objects.inv
            - https://numpy.org/doc/stable/objects.inv
            - https://pandas.pydata.org/docs/objects.inv
            - https://docs.scipy.org/doc/scipy/objects.inv
            - https://numpydantic.readthedocs.io/en/latest/objects.inv
            - https://docs.pydantic.dev/latest/objects.inv
          options:
            extensions:
              - griffe_pydantic:
                  schema: true
            docstring_style: google
            docstring_section_style: table
            members_order: alphabetical
            show_root_heading: true
            show_source: true
            separate_signature: true
            show_signature: true
            show_signature_annotations: true
            signature_crossrefs: true
            #
            merge_init_into_class: true
            show_if_no_docstring: false
            # annotations_path: full
            show_docstring_functions: true
            heading_level: 2
            line_length: 100
            show_root_toc_entry: false
            show_root_full_path: false
            inherited_members: false
            show_submodules: false
            show_docstring_classes: true
            docstring_options:
              ignore_init_summary: false
          paths: [src]
  #
  - exclude:
      glob:
        - snippets/*
  - snippets

watch:
  - src/
  - scripts/
  - docs/