pyoframe/mkdocs.yml at main · Bravos-Power/pyoframe · 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
# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json
site_name: Pyoframe
site_url: https://Bravos-Power.github.io/pyoframe/
repo_url: https://github.com/Bravos-Power/pyoframe
edit_uri: edit/main/docs/
copyright: Copyright &copy; 2024-2025 Bravos Power
theme:
  name: material
  icon:
    repo: fontawesome/brands/github
  language: en
  custom_dir: docs/overrides
  font:
    text: Roboto
    code: monospace # Because the Google CDN has issues that make Polars display incorrectly https://github.com/google/fonts/issues/4235
  palette:
    - primary: red
    # Palette toggle for light mode
    - scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.instant.progress
    - navigation.tracking
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - navigation.footer
    - toc.follow
    - navigation.indexes
    - content.action.edit
    - content.action.view
    - content.code.copy
    - content.code.annotate
    - content.tooltips

markdown_extensions:
  - admonition
  - codehilite
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - attr_list
  - abbr
  - md_in_html
  - footnotes
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - markdown_katex  # For rendering LaTeX math

plugins:
  - search
  - table-reader
  - mkdocstrings:
      handlers:
        python:
          options:
            unwrap_annotated: true
            show_bases: true # Do not show base classes in the class documentation.
            inherited_members: false # Include inherited methods in children classes.
            filters: ["!^_"] # Exclude dunder methods from documentation.
            show_if_no_docstring: true
            show_signature: true
            show_signature_annotations: true
            summary:
              attributes: true
              functions: true
              classes: true
              modules: false
            extensions: # https://mkdocstrings.github.io/python/usage/configuration/general/?h=griffe#extensions
              - dataclasses
              - scripts/griffe_extensions.py
            merge_init_into_class: true
            show_labels: false # https://mkdocstrings.github.io/python/usage/configuration/members/#show_labels
            docstring_options:
              ignore_init_summary: true
              trim_doctest_flags: true
  - git-revision-date-localized:
      enable_creation_date: true
      exclude:
        - index.md
      enabled: !ENV [ENABLED_GIT_REVISION_DATE, false]
  - git-committers:
      repository: Bravos-Power/pyoframe
      branch: main
      exclude:
        - index.md
      enabled: !ENV [ENABLED_GIT_COMMITTERS, false]
  - awesome-nav
  - gen-files:
      scripts:
        - scripts/generate_api_reference.py
  - mike

extra_javascript:
  - javascripts/feedback.js

extra_css:
  - stylesheets/extra.css

extra:
  pre_release: !ENV [DOCS_PRERELEASE, false]
  version:
    #  https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/
    provider: mike
    default:
      - latest
      - dev  # included so that there's no outdated warning
    alias: true
  analytics:
    provider: custom
    feedback:
      title: Was this page helpful?
      ratings:
        - icon: material/emoticon-happy-outline
          name: This page was helpful
          data: 1
          note: Thanks for your feedback!
        - icon: material/emoticon-sad-outline
          name: This page could be improved
          data: 0
          note: Let us know how we can improve this page.

validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn
  anchors: warn

watch:
  - src