Skip to content

Commit e4fe0cf

Browse files
committed
Update mkdocs config
1 parent 76cd8db commit e4fe0cf

File tree

1 file changed

+52
-20
lines changed

1 file changed

+52
-20
lines changed

mkdocs.yml

Lines changed: 52 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -12,41 +12,90 @@ theme:
1212
name: material
1313
icon:
1414
repo: fontawesome/brands/github
15+
language: en
1516

1617
features:
1718
- navigation.instant
18-
- navigation.instant
19+
- navigation.path
20+
- navigation.instant.prefetch
21+
- navigation.instant.progress
1922
- navigation.tabs
23+
- navigation.tabs.sticky
2024
- navigation.top
2125
- navigation.sections
2226
- navigation.expand
27+
- navigation.indexes
28+
- navigation.tracking
2329
- toc.integrate
2430
- search.suggest
2531
- search.highlight
2632
- content.code.copy
2733
- content.code.annotate
34+
- content.code.select
2835
- content.tabs.link
2936
- content.action.edit
3037
- content.action.view
3138
- content.footnote.tooltips
39+
- toc.follow
3240

3341
font:
3442
text: Roboto
3543

3644
palette:
3745
- scheme: default
3846
primary: indigo
39-
accent: pink
47+
accent: amber
4048
toggle:
4149
icon: material/brightness-7
4250
name: Switch to dark mode
4351
- scheme: slate
4452
primary: indigo
45-
accent: pink
53+
accent: amber
4654
toggle:
4755
icon: material/brightness-4
4856
name: Switch to light mode
4957

58+
plugins:
59+
- search:
60+
lang: en
61+
separator: '[\s\-\.]+'
62+
pipeline:
63+
- stemmer
64+
- stopWordFilter
65+
- mkdocstrings:
66+
handlers:
67+
python:
68+
options:
69+
merge_init_into_class: true
70+
signature_crossrefs: true
71+
show_symbol_type_heading: true
72+
show_symbol_type_toc: true
73+
separate_signature: true
74+
unwrap_annotated: true
75+
members_order: source
76+
preload_modules:
77+
- httpx
78+
- starlette
79+
docstring_style: google
80+
show_source: true
81+
show_signature: true
82+
show_root_heading: true
83+
show_inheritance_diagram: true
84+
extra:
85+
follow_wrapped: true
86+
87+
markdown_extensions:
88+
- pymdownx.highlight:
89+
anchor_linenums: true
90+
line_spans: __span
91+
pygments_lang_class: true
92+
- pymdownx.inlinehilite
93+
- pymdownx.snippets
94+
- pymdownx.superfences
95+
96+
extra_javascript:
97+
- https://unpkg.com/mermaid@10.9.0/dist/mermaid.min.js
98+
5099
nav:
51100
- Home: index.md
52101
- Quick Start: quickstart.md
@@ -69,20 +118,3 @@ extra:
69118
type: info
70119
text: "⭐️ Star FastAPI-Cap on [GitHub](https://github.com/devbijay/FastAPI-Cap)!"
71120

72-
plugins:
73-
- search:
74-
lang: en
75-
separator: '[\s\-\.]+'
76-
pipeline:
77-
- stemmer
78-
- stopWordFilter
79-
- mkdocstrings:
80-
handlers:
81-
python:
82-
options:
83-
docstring_style: google
84-
show_source: true
85-
show_signature: true
86-
show_root_heading: true
87-
extra:
88-
follow_wrapped: true

0 commit comments

Comments
 (0)