fxhoudinimcp/mkdocs.yml at main · healkeiser/fxhoudinimcp · 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
# Base for MkDocs.

# Author: Valentin Beaumont
# Mail: valentin.onze@gmail.com

site_name: fxhoudinimcp
site_author: Valentin Beaumont
copyright: Valentin Beaumont | Licensed under the MIT License
repo_url: https://github.com/healkeiser/fxhoudinimcp
repo_name: healkeiser/fxhoudinimcp
edit_uri: edit/main/docs/

###### Navigation ##############################################################

nav:
  - Home: index.md
  - Installation: installation.md
  - How-to:
      - Overview: how-to/index.md
      - Configuration: how-to/configuration.md
      - Tools: how-to/tools.md
  - Technical: technical/
  - Changelog: changelog.md

###### Custom ##################################################################

extra_css:
  - stylesheets/extra.css

extra:
  status:
    new: Recently added
    deprecated: No longer supported
  version:
    provider: mike
    default: latest
    alias: true

###### Theme ###################################################################

theme:
  name: material
  language: en
  favicon: images/favicon.svg
  logo: images/logo.svg
  icon:
    repo: material/github
  features:
    - announce.dismiss
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.path
    - navigation.instant
    - navigation.instant.prefetch
    - search.suggest
    - search.highlight
    - toc.follow
    - content.code.annotate
    - content.code.copy
    - content.tooltips
    - content.tabs.link
    - content.action.edit
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: black
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

###### Markdown extensions #####################################################

markdown_extensions:
  - toc:
      permalink: true
  - footnotes
  - admonition
  - attr_list
  - md_in_html
  - def_list
  - tables
  - pymdownx.details
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.critic
  - pymdownx.caret
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.tilde
  - pymdownx.b64
  - pymdownx.smartsymbols
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

plugins:
  - search
  - git-authors:
      exclude:
        - technical/**
  - gen-files:
      enabled: true
      scripts:
        - docs/.scripts/generate_technical_docs.py
  - literate-nav:
      nav_file: SUMMARY.md
  - section-index
  - git-revision-date-localized:
      enable_creation_date: true
  - git-committers:
      repository: healkeiser/fxhoudinimcp
      branch: main
      token: !ENV [GH_TOKEN, ""]
  - mkdocstrings:
      enabled: !ENV [ENABLE_MKDOCSTRINGS, true]
      handlers:
        python:
          paths: ["python"]
          inventories:
            - https://docs.python.org/3/objects.inv
          options:
            heading_level: 2
            show_source: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            separate_signature: true
            parameter_headings: true
            line_length: 80
            show_signature_annotations: true
            signature_crossrefs: true
            docstring_style: google
            docstring_section_style: table
            show_if_no_docstring: false
            show_docstring_attributes: true
            annotations_path: brief
            show_submodules: false
            show_root_heading: true
            show_root_full_path: false
            find_stubs_package: true
            summary: true
            members_order: alphabetical
            group_by_category: true
            show_category_heading: true
            merge_init_into_class: true
            show_inheritance_diagram: true