fastapi-typed-errors/mkdocs.yml at main · feodor-ra/fastapi-typed-errors · 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
site_name: fastapi-typed-errors
site_description: Typed HTTP errors for FastAPI — exact Literal codes in OpenAPI, discriminated oneOf unions, a single source of truth.
site_url: https://feodor-ra.github.io/fastapi-typed-errors/
repo_url: https://github.com/feodor-ra/fastapi-typed-errors
repo_name: feodor-ra/fastapi-typed-errors
edit_uri: edit/main/docs/
copyright: MIT License

extra_css:
  - stylesheets/extra.css

theme:
  name: material
  custom_dir: overrides
  icon:
    logo: material/alert-decagram-outline
    repo: fontawesome/brands/github
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - navigation.tracking
    - navigation.footer
    - toc.follow
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - pymdownx.details
  - pymdownx.snippets
  - 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:
      lang:
        - en
        - ru
  - i18n:
      docs_structure: folder
      languages:
        - locale: en
          name: English
          default: true
          build: true
        - locale: ru
          name: Русский
          build: true
          nav_translations:
            Overview: Обзор
            Guide: Руководство
            API Reference: Справочник API
            Changelog: История изменений
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            docstring_style: google
            docstring_section_style: table
            separate_signature: true
            signature_crossrefs: true
            show_signature_annotations: true
            merge_init_into_class: true
            show_source: false
            show_root_heading: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            members_order: source
            filters:
              - "!^_"

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/feodor-ra/fastapi-typed-errors
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/fastapi-typed-errors/

nav:
  - Overview:
      - index.md
      - quickstart.md
  - Guide:
      - guide/core.md
      - guide/decorator.md
      - guide/checker.md
      - guide/customization.md
      - guide/recipes.md
      - guide/limitations.md
  - API Reference:
      - reference/core.md
      - reference/decorator.md
      - reference/analysis.md
  - Changelog:
      - changelog.md