Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit b71f5bf

Browse filesBrowse files
committed
Deployed 879cbf4 with MkDocs version: 1.6.1
1 parent 7ea126b commit b71f5bf
Copy full SHA for b71f5bf

File tree

Expand file treeCollapse file tree

35 files changed

+1923
-206
lines changed
Filter options
Expand file treeCollapse file tree

35 files changed

+1923
-206
lines changed

‎404.html

Copy file name to clipboardExpand all lines: 404.html
+1-1Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎assets/_mkdocstrings.css

Copy file name to clipboardExpand all lines: assets/_mkdocstrings.css
+34-6Lines changed: 34 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,28 @@
4242
font-weight: bold;
4343
}
4444

45+
/* Backlinks crumb separator. */
46+
.doc-backlink-crumb {
47+
display: inline-flex;
48+
gap: .2rem;
49+
white-space: nowrap;
50+
align-items: center;
51+
vertical-align: middle;
52+
}
53+
.doc-backlink-crumb:not(:first-child)::before {
54+
background-color: var(--md-default-fg-color--lighter);
55+
content: "";
56+
display: inline;
57+
height: 1rem;
58+
--md-path-icon: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M8.59 16.58 13.17 12 8.59 7.41 10 6l6 6-6 6z"/></svg>');
59+
-webkit-mask-image: var(--md-path-icon);
60+
mask-image: var(--md-path-icon);
61+
width: 1rem;
62+
}
63+
.doc-backlink-crumb.last {
64+
font-weight: bold;
65+
}
66+
4567
/* Symbols in Navigation and ToC. */
4668
:root, :host,
4769
[data-md-color-scheme="default"] {
@@ -83,7 +105,8 @@ code.doc-symbol {
83105
font-weight: bold;
84106
}
85107

86-
code.doc-symbol-parameter {
108+
code.doc-symbol-parameter,
109+
a code.doc-symbol-parameter {
87110
color: var(--doc-symbol-parameter-fg-color);
88111
background-color: var(--doc-symbol-parameter-bg-color);
89112
}
@@ -92,7 +115,8 @@ code.doc-symbol-parameter::after {
92115
content: "param";
93116
}
94117

95-
code.doc-symbol-attribute {
118+
code.doc-symbol-attribute,
119+
a code.doc-symbol-attribute {
96120
color: var(--doc-symbol-attribute-fg-color);
97121
background-color: var(--doc-symbol-attribute-bg-color);
98122
}
@@ -101,7 +125,8 @@ code.doc-symbol-attribute::after {
101125
content: "attr";
102126
}
103127

104-
code.doc-symbol-function {
128+
code.doc-symbol-function,
129+
a code.doc-symbol-function {
105130
color: var(--doc-symbol-function-fg-color);
106131
background-color: var(--doc-symbol-function-bg-color);
107132
}
@@ -110,7 +135,8 @@ code.doc-symbol-function::after {
110135
content: "func";
111136
}
112137

113-
code.doc-symbol-method {
138+
code.doc-symbol-method,
139+
a code.doc-symbol-method {
114140
color: var(--doc-symbol-method-fg-color);
115141
background-color: var(--doc-symbol-method-bg-color);
116142
}
@@ -119,7 +145,8 @@ code.doc-symbol-method::after {
119145
content: "meth";
120146
}
121147

122-
code.doc-symbol-class {
148+
code.doc-symbol-class,
149+
a code.doc-symbol-class {
123150
color: var(--doc-symbol-class-fg-color);
124151
background-color: var(--doc-symbol-class-bg-color);
125152
}
@@ -128,7 +155,8 @@ code.doc-symbol-class::after {
128155
content: "class";
129156
}
130157

131-
code.doc-symbol-module {
158+
code.doc-symbol-module,
159+
a code.doc-symbol-module {
132160
color: var(--doc-symbol-module-fg-color);
133161
background-color: var(--doc-symbol-module-bg-color);
134162
}

‎assets/javascripts/bundle.10a6bb14.min.js

Copy file name to clipboardExpand all lines: assets/javascripts/bundle.10a6bb14.min.js
+3Lines changed: 3 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎assets/javascripts/bundle.5a789024.min.js

Copy file name to clipboardExpand all lines: assets/javascripts/bundle.5a789024.min.js
-3Lines changed: 0 additions & 3 deletions
This file was deleted.

‎changelog/index.html

Copy file name to clipboardExpand all lines: changelog/index.html
+2-2Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

‎code_of_conduct/index.html

Copy file name to clipboardExpand all lines: code_of_conduct/index.html
+2-2Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

‎contributing/index.html

Copy file name to clipboardExpand all lines: contributing/index.html
+2-2Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

‎credits/index.html

Copy file name to clipboardExpand all lines: credits/index.html
+2-2Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

‎css/mkdocstrings.css

Copy file name to clipboardExpand all lines: css/mkdocstrings.css
+45Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,3 +25,48 @@ a.external:hover::after,
2525
a.autorefs-external:hover::after {
2626
background-color: var(--md-accent-fg-color);
2727
}
28+
29+
/* Tree-like output for backlinks. */
30+
.doc-backlink-list {
31+
--tree-clr: var(--md-default-fg-color);
32+
--tree-font-size: 1rem;
33+
--tree-item-height: 1;
34+
--tree-offset: 1rem;
35+
--tree-thickness: 1px;
36+
--tree-style: solid;
37+
display: grid;
38+
list-style: none !important;
39+
}
40+
41+
.doc-backlink-list li > span:first-child {
42+
text-indent: .3rem;
43+
}
44+
.doc-backlink-list li {
45+
padding-inline-start: var(--tree-offset);
46+
border-left: var(--tree-thickness) var(--tree-style) var(--tree-clr);
47+
position: relative;
48+
margin-left: 0 !important;
49+
50+
&:last-child {
51+
border-color: transparent;
52+
}
53+
&::before{
54+
content: '';
55+
position: absolute;
56+
top: calc(var(--tree-item-height) / 2 * -1 * var(--tree-font-size) + var(--tree-thickness));
57+
left: calc(var(--tree-thickness) * -1);
58+
width: calc(var(--tree-offset) + var(--tree-thickness) * 2);
59+
height: calc(var(--tree-item-height) * var(--tree-font-size));
60+
border-left: var(--tree-thickness) var(--tree-style) var(--tree-clr);
61+
border-bottom: var(--tree-thickness) var(--tree-style) var(--tree-clr);
62+
}
63+
&::after{
64+
content: '';
65+
position: absolute;
66+
border-radius: 50%;
67+
background-color: var(--tree-clr);
68+
top: calc(var(--tree-item-height) / 2 * 1rem);
69+
left: var(--tree-offset) ;
70+
translate: calc(var(--tree-thickness) * -1) calc(var(--tree-thickness) * -1);
71+
}
72+
}

‎index.html

Copy file name to clipboardExpand all lines: index.html
+2-2Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

‎insiders/changelog/index.html

Copy file name to clipboardExpand all lines: insiders/changelog/index.html
+2-2Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

‎insiders/goals.yml

Copy file name to clipboardExpand all lines: insiders/goals.yml
+3Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,3 +42,6 @@ goals:
4242
- name: Scoped cross-references
4343
ref: /usage/configuration/docstrings/#scoped_crossrefs
4444
since: 2024/09/03
45+
- name: Backlinks
46+
ref: /usage/configuration/general/#backlinks
47+
since: 2025/03/10

‎insiders/index.html

Copy file name to clipboardExpand all lines: insiders/index.html
+2-2Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

‎insiders/installation/index.html

Copy file name to clipboardExpand all lines: insiders/installation/index.html
+2-2Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

‎license/index.html

Copy file name to clipboardExpand all lines: license/index.html
+2-2Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

‎objects.inv

Copy file name to clipboard
46 Bytes
Binary file not shown.

‎reference/SUMMARY/index.html

Copy file name to clipboardExpand all lines: reference/SUMMARY/index.html
+2-2Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

‎reference/mkdocstrings_handlers/python/config/index.html

Copy file name to clipboardExpand all lines: reference/mkdocstrings_handlers/python/config/index.html
+1,404-55Lines changed: 1404 additions & 55 deletions
Large diffs are not rendered by default.

‎reference/mkdocstrings_handlers/python/debug/index.html

Copy file name to clipboardExpand all lines: reference/mkdocstrings_handlers/python/debug/index.html
+117-12Lines changed: 117 additions & 12 deletions
Large diffs are not rendered by default.

‎reference/mkdocstrings_handlers/python/handler/index.html

Copy file name to clipboardExpand all lines: reference/mkdocstrings_handlers/python/handler/index.html
+136-35Lines changed: 136 additions & 35 deletions
Large diffs are not rendered by default.

‎reference/mkdocstrings_handlers/python/index.html

Copy file name to clipboardExpand all lines: reference/mkdocstrings_handlers/python/index.html
+6-6Lines changed: 6 additions & 6 deletions
Large diffs are not rendered by default.

‎reference/mkdocstrings_handlers/python/rendering/index.html

Copy file name to clipboardExpand all lines: reference/mkdocstrings_handlers/python/rendering/index.html
+64-41Lines changed: 64 additions & 41 deletions
Large diffs are not rendered by default.

‎schema.json

Copy file name to clipboardExpand all lines: schema.json
+11Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -297,6 +297,17 @@
297297
"title": "annotations_path",
298298
"type": "string"
299299
},
300+
"backlinks": {
301+
"default": false,
302+
"description": "Whether to render backlinks, and how.",
303+
"enum": [
304+
"flat",
305+
"tree",
306+
false
307+
],
308+
"markdownDescription": "[DOCUMENTATION](https://mkdocstrings.github.io/python/usage/configuration/general/#backlinks)\n\nWhether to render backlinks, and how.",
309+
"title": "backlinks"
310+
},
300311
"docstring_options": {
301312
"anyOf": [
302313
{

‎search/search_index.json

Copy file name to clipboardExpand all lines: search/search_index.json
+1-1Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎usage/configuration/docstrings/index.html

Copy file name to clipboardExpand all lines: usage/configuration/docstrings/index.html
+2-2Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

‎usage/configuration/general/index.html

Copy file name to clipboardExpand all lines: usage/configuration/general/index.html
+10-4Lines changed: 10 additions & 4 deletions
Large diffs are not rendered by default.

‎usage/configuration/headings/index.html

Copy file name to clipboardExpand all lines: usage/configuration/headings/index.html
+4-4Lines changed: 4 additions & 4 deletions
Large diffs are not rendered by default.

‎usage/configuration/members/index.html

Copy file name to clipboardExpand all lines: usage/configuration/members/index.html
+2-2Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

‎usage/configuration/signatures/index.html

Copy file name to clipboardExpand all lines: usage/configuration/signatures/index.html
+2-2Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

‎usage/customization/index.html

Copy file name to clipboardExpand all lines: usage/customization/index.html
+48-2Lines changed: 48 additions & 2 deletions
Large diffs are not rendered by default.

‎usage/docstrings/google/index.html

Copy file name to clipboardExpand all lines: usage/docstrings/google/index.html
+2-2Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

‎usage/docstrings/numpy/index.html

Copy file name to clipboardExpand all lines: usage/docstrings/numpy/index.html
+2-2Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

‎usage/docstrings/sphinx/index.html

Copy file name to clipboardExpand all lines: usage/docstrings/sphinx/index.html
+2-2Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

‎usage/extensions/index.html

Copy file name to clipboardExpand all lines: usage/extensions/index.html
+2-2Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

‎usage/index.html

Copy file name to clipboardExpand all lines: usage/index.html
+2-2Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.