Skip to content

Commit 13c1c6e

Browse files
authored
[SYNPY-1423] update mkdocstrings dependency for 1.8.0 (#1145)
* upgrade to mkdocstring 1.8.0
1 parent b77c2b1 commit 13c1c6e

File tree

5 files changed

+106
-178
lines changed

5 files changed

+106
-178
lines changed

docs/css/custom.css

Lines changed: 0 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,3 @@
1-
[data-md-color-scheme="default"] {
2-
--doc-symbol-attribute-fg-color: #953800;
3-
--doc-symbol-function-fg-color: #8250df;
4-
--doc-symbol-method-fg-color: #8250df;
5-
--doc-symbol-class-fg-color: #0550ae;
6-
--doc-symbol-module-fg-color: #5cad0f;
7-
8-
--doc-symbol-attribute-bg-color: #9538001a;
9-
--doc-symbol-function-bg-color: #8250df1a;
10-
--doc-symbol-method-bg-color: #8250df1a;
11-
--doc-symbol-class-bg-color: #0550ae1a;
12-
--doc-symbol-module-bg-color: #5cad0f1a;
13-
}
14-
15-
[data-md-color-scheme="slate"] {
16-
--doc-symbol-attribute-fg-color: #953800;
17-
--doc-symbol-function-fg-color: #8250df;
18-
--doc-symbol-method-fg-color: #8250df;
19-
--doc-symbol-class-fg-color: #0550ae;
20-
--doc-symbol-module-fg-color: #5cad0f;
21-
22-
--doc-symbol-attribute-bg-color: #9538001a;
23-
--doc-symbol-function-bg-color: #8250df1a;
24-
--doc-symbol-method-bg-color: #8250df1a;
25-
--doc-symbol-class-bg-color: #0550ae1a;
26-
--doc-symbol-module-bg-color: #5cad0f1a;
27-
}
28-
291
/* Indentation. */
302
div.doc-contents {
313
padding-left: 25px;
@@ -35,37 +7,3 @@ div.doc-contents {
357
.md-typeset table tbody {
368
font-size: .7rem
379
}
38-
39-
/* Adds icons in front of `class`, `attribute`, and `function` */
40-
div.doc-class .doc-heading:first-of-type::before {
41-
color: var(--doc-symbol-class-fg-color);
42-
background-color: var(--doc-symbol-class-bg-color);
43-
border-radius: .1rem;
44-
font-size: .85em;
45-
padding: 0 .3em;
46-
font-weight: bold;
47-
content: "class";
48-
margin-right: 5px;
49-
}
50-
51-
div.doc-attribute .doc-heading:first-of-type::before {
52-
color: var(--doc-symbol-attribute-fg-color);
53-
background-color: var(--doc-symbol-attribute-bg-color);
54-
border-radius: .1rem;
55-
font-size: .85em;
56-
padding: 0 .3em;
57-
font-weight: bold;
58-
content: "attr";
59-
margin-right: 5px;
60-
}
61-
62-
div.doc-function .doc-heading:first-of-type::before {
63-
color: var(--doc-symbol-function-fg-color);
64-
background-color: var(--doc-symbol-function-bg-color);
65-
border-radius: .1rem;
66-
font-size: .85em;
67-
padding: 0 .3em;
68-
font-weight: bold;
69-
content: "func";
70-
margin-right: 5px;
71-
}

mkdocs.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,15 +130,24 @@ plugins:
130130
default_handler: python
131131
handlers:
132132
python:
133+
import:
134+
- https://docs.python.org/3/objects.inv
135+
- https://python-markdown.github.io/objects.inv
133136
options:
134137
members_order: source
135138
show_if_no_docstring: False
136139
show_root_heading: True
137140
show_category_heading: True
141+
show_symbol_type_heading: True
142+
show_symbol_type_toc: True
138143
docstring_style: google
139144
docstring_section_style: spacy
140145
filters:
141146
- "!^_"
147+
separate_signature: True
148+
show_signature_annotations: True
149+
signature_crossrefs: True
150+
142151
- autorefs
143152
- termynal:
144153
prompt_literal_start:

setup.cfg

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ docs =
114114
mkdocs>=1.5.3
115115
mkdocs-material>=9.4.14
116116
mkdocstrings>=0.24.0
117-
mkdocstrings-python>=1.7.5
117+
mkdocstrings-python>=1.8.0
118118
termynal>=0.11.1
119119
mkdocs-open-in-new-tab~=1.0.3
120120
markdown-include~=0.8.1

0 commit comments

Comments
 (0)