Skip to content

Commit 8eebfce

Browse files
committed
refactor: Make source admonitions more subtle
Issue-mkdocstrings#525: mkdocstrings/mkdocstrings#525
1 parent 7f95686 commit 8eebfce

File tree

4 files changed

+73
-4
lines changed

4 files changed

+73
-4
lines changed

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ plugins:
175175
show_root_heading: true
176176
show_root_full_path: false
177177
show_signature_annotations: true
178-
show_source: false
178+
show_source: true
179179
show_symbol_type_heading: true
180180
show_symbol_type_toc: true
181181
signature_crossrefs: true

src/mkdocstrings_handlers/python/templates/material/_base/class.html.jinja

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,7 @@ Context:
119119
{% endif %}
120120

121121
<div class="doc doc-contents {% if root %}first{% endif %}">
122+
122123
{% block contents scoped %}
123124
{#- Contents block.
124125
@@ -192,7 +193,7 @@ Context:
192193
{% if config.merge_init_into_class %}
193194
{% if "__init__" in all_members and all_members["__init__"].source %}
194195
{% with init = all_members["__init__"] %}
195-
<details class="quote">
196+
<details class="mkdocstrings-source">
196197
<summary>Source code in <code>
197198
{%- if init.relative_filepath.is_absolute() -%}
198199
{{ init.relative_package_filepath }}
@@ -205,7 +206,7 @@ Context:
205206
{% endwith %}
206207
{% endif %}
207208
{% elif class.source %}
208-
<details class="quote">
209+
<details class="mkdocstrings-source">
209210
<summary>Source code in <code>
210211
{%- if class.relative_filepath.is_absolute() -%}
211212
{{ class.relative_package_filepath }}

src/mkdocstrings_handlers/python/templates/material/_base/function.html.jinja

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ Context:
145145
This block renders the source code for the function.
146146
-#}
147147
{% if config.show_source and function.source %}
148-
<details class="quote">
148+
<details class="mkdocstrings-source">
149149
<summary>{{ lang.t("Source code in") }} <code>
150150
{%- if function.relative_filepath.is_absolute() -%}
151151
{{ function.relative_package_filepath }}

src/mkdocstrings_handlers/python/templates/material/style.css

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -178,3 +178,71 @@ code.doc-symbol-module::after {
178178
color: inherit;
179179
border-bottom: 1px dotted currentcolor;
180180
}
181+
182+
:root {
183+
--md-admonition-icon--source: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m14.6 16.6 4.6-4.6-4.6-4.6L16 6l6 6-6 6zm-5.2 0L4.8 12l4.6-4.6L8 6l-6 6 6 6z"/></svg>')
184+
/* --md-admonition-icon--source: "" */
185+
}
186+
.md-typeset .admonition.source,
187+
.md-typeset details.source {
188+
border-color: var(--md-code-bg-color);
189+
}
190+
.md-typeset .source > .admonition-title,
191+
.md-typeset .source > summary {
192+
background-color: var(--md-code-bg-color);
193+
}
194+
.md-typeset .source > .admonition-title::before,
195+
.md-typeset .source > summary::before {
196+
/* background-color: rgb(128, 128, 128); */
197+
background-color: var(--md-code-bg-color);
198+
/* -webkit-mask-image: var(--md-admonition-icon--source);
199+
mask-image: var(--md-admonition-icon--source); */
200+
-webkit-mask-image: unset;
201+
mask-image: unset;
202+
}
203+
204+
.doc details.source {
205+
background-color: var(--md-code-bg-color);
206+
border: 0;
207+
border-radius: 0;
208+
margin: 0;
209+
padding: 0;
210+
transition: none;
211+
}
212+
213+
.doc details.source summary {
214+
background-color: inherit;
215+
border: 0;
216+
border-radius: 0;
217+
padding-top: 0;
218+
padding-bottom: 0;
219+
}
220+
221+
222+
.doc details.source summary code {
223+
box-shadow: none;
224+
padding: 0;
225+
}
226+
227+
/* Source code blocks (admonitions). */
228+
:root {
229+
--md-admonition-icon--mkdocstrings-source: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.75.75 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06m-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.75.75 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0"/></svg>')
230+
}
231+
.md-typeset .admonition.mkdocstrings-source,
232+
.md-typeset details.mkdocstrings-source {
233+
border: none;
234+
padding: 0;
235+
}
236+
.md-typeset .admonition.mkdocstrings-source:focus-within,
237+
.md-typeset details.mkdocstrings-source:focus-within {
238+
box-shadow: none;
239+
}
240+
.md-typeset .mkdocstrings-source > .admonition-title,
241+
.md-typeset .mkdocstrings-source > summary {
242+
background-color: inherit;
243+
}
244+
.md-typeset .mkdocstrings-source > .admonition-title::before,
245+
.md-typeset .mkdocstrings-source > summary::before {
246+
-webkit-mask-image: var(--md-admonition-icon--mkdocstrings-source);
247+
mask-image: var(--md-admonition-icon--mkdocstrings-source);
248+
}

0 commit comments

Comments
 (0)