Skip to content

Commit 1ad3c89

Browse files
committed
updates mkdocs.yml, adds reference/server.md
1 parent c056445 commit 1ad3c89

File tree

2 files changed

+31
-10
lines changed

2 files changed

+31
-10
lines changed

docs/reference/server.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Server
2+
3+
::: icon.server
4+
handler: python
5+
options:
6+
show_root_heading: false
7+
show_root_toc_entry: false
8+

mkdocs.yml

Lines changed: 23 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ edit_uri: blob/main/docs/
44
nav:
55
- Home: index.md
66
- Getting Started: getting-started.md
7+
- Reference:
8+
- Icon Server: reference/server.md
79
- About:
810
- License: about/license.md
911

@@ -40,22 +42,33 @@ plugins:
4042
- https://confz.readthedocs.io/en/latest/objects.inv
4143
- https://python-socketio.readthedocs.io/en/stable/objects.inv
4244
options:
45+
# General
4346
show_source: true
44-
inherited_members: true
45-
merge_init_into_class: true
46-
show_signature_annotations: true
47-
signature_crossrefs: true
48-
separate_signature: true
49-
docstring_options:
50-
ignore_init_summary: true
51-
# docstring_section_style: list
47+
48+
# Headings
5249
heading_level: 2
53-
parameter_headings: true
50+
parameter_headings: false
5451
show_root_heading: true
5552
show_root_full_path: true
5653
show_symbol_type_heading: true
5754
show_symbol_type_toc: true
58-
# summary: true
55+
56+
# Members
57+
show_submodules: true
58+
inherited_members: true
59+
summary: true
60+
61+
# Docstrings
62+
merge_init_into_class: true
63+
docstring_options:
64+
ignore_init_summary: false
65+
# docstring_section_style: list
66+
show_if_no_docstring: true
67+
68+
# Signatures
69+
show_signature_annotations: true
70+
signature_crossrefs: true
71+
separate_signature: true
5972
unwrap_annotated: true
6073
# - swagger-ui-tag
6174

0 commit comments

Comments
 (0)