Skip to content

Commit 51f217f

Browse files
committed
chore: Template upgrade
1 parent b1da3d0 commit 51f217f

File tree

7 files changed

+69
-18
lines changed

7 files changed

+69
-18
lines changed

.copier-answers.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Changes here will be overwritten by Copier.
2-
_commit: 1.7.1
2+
_commit: 1.8.4
33
_src_path: gh:pawamoy/copier-uv
44
author_email: [email protected]
55
author_fullname: Timothée Mazzucotelli

docs/css/mkdocstrings.css

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,3 +35,48 @@ td code {
3535
li.md-nav__item:has(> a[href*="("]) {
3636
display: none;
3737
}
38+
39+
/* Tree-like output for backlinks. */
40+
.doc-backlink-list {
41+
--tree-clr: var(--md-default-fg-color);
42+
--tree-font-size: 1rem;
43+
--tree-item-height: 1;
44+
--tree-offset: 1rem;
45+
--tree-thickness: 1px;
46+
--tree-style: solid;
47+
display: grid;
48+
list-style: none !important;
49+
}
50+
51+
.doc-backlink-list li > span:first-child {
52+
text-indent: .3rem;
53+
}
54+
.doc-backlink-list li {
55+
padding-inline-start: var(--tree-offset);
56+
border-left: var(--tree-thickness) var(--tree-style) var(--tree-clr);
57+
position: relative;
58+
margin-left: 0 !important;
59+
60+
&:last-child {
61+
border-color: transparent;
62+
}
63+
&::before{
64+
content: '';
65+
position: absolute;
66+
top: calc(var(--tree-item-height) / 2 * -1 * var(--tree-font-size) + var(--tree-thickness));
67+
left: calc(var(--tree-thickness) * -1);
68+
width: calc(var(--tree-offset) + var(--tree-thickness) * 2);
69+
height: calc(var(--tree-item-height) * var(--tree-font-size));
70+
border-left: var(--tree-thickness) var(--tree-style) var(--tree-clr);
71+
border-bottom: var(--tree-thickness) var(--tree-style) var(--tree-clr);
72+
}
73+
&::after{
74+
content: '';
75+
position: absolute;
76+
border-radius: 50%;
77+
background-color: var(--tree-clr);
78+
top: calc(var(--tree-item-height) / 2 * 1rem);
79+
left: var(--tree-offset) ;
80+
translate: calc(var(--tree-thickness) * -1) calc(var(--tree-thickness) * -1);
81+
}
82+
}
File renamed without changes.

mkdocs.yml

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ nav:
3434
- Guides:
3535
- Recipes: recipes.md
3636
- Troubleshooting: troubleshooting.md
37-
- API reference: reference/mkdocstrings.md
37+
- API reference: reference/api.md
3838
- Development:
3939
- Contributing: contributing.md
4040
- Code of Conduct: code_of_conduct.md
@@ -143,6 +143,7 @@ plugins:
143143
- https://markupsafe.palletsprojects.com/en/stable/objects.inv
144144
paths: [src]
145145
options:
146+
backlinks: tree
146147
docstring_options:
147148
ignore_init_summary: true
148149
docstring_section_style: list
@@ -161,16 +162,17 @@ plugins:
161162
signature_crossrefs: true
162163
summary: true
163164
- llmstxt:
164-
files:
165-
- output: llms-full.txt
166-
inputs:
165+
full_output: llms-full.txt
166+
sections:
167+
Usage:
167168
- index.md
168169
- usage/index.md
169170
- usage/handlers.md
170171
- usage/theming.md
171172
- recipes.md
172173
- troubleshooting.md
173-
- reference/**.md
174+
API:
175+
- reference/api.md
174176
- git-revision-date-localized:
175177
enabled: !ENV [DEPLOY, false]
176178
enable_creation_date: true
@@ -179,14 +181,15 @@ plugins:
179181
redirect_maps:
180182
theming.md: usage/theming.md
181183
handlers/overview.md: usage/handlers.md
182-
reference/index.md: reference/mkdocstrings.md#mkdocstrings
183-
reference/extension.md: reference/mkdocstrings.md#mkdocstrings.extension
184-
reference/handlers/index.md: reference/mkdocstrings.md#mkdocstrings.handlers
185-
reference/handlers/base.md: reference/mkdocstrings.md#mkdocstrings.handlers.base
186-
reference/handlers/rendering.md: reference/mkdocstrings.md#mkdocstrings.handlers.rendering
187-
reference/inventory.md: reference/mkdocstrings.md#mkdocstrings.inventory
188-
reference/loggers.md: reference/mkdocstrings.md#mkdocstrings.loggers
189-
reference/plugin.md: reference/mkdocstrings.md#mkdocstrings.plugin
184+
reference/mkdocstrings.md: reference/api.md
185+
reference/index.md: reference/api.md#mkdocstrings
186+
reference/extension.md: reference/api.md#mkdocstrings.extension
187+
reference/handlers/index.md: reference/api.md#mkdocstrings.handlers
188+
reference/handlers/base.md: reference/api.md#mkdocstrings.handlers.base
189+
reference/handlers/rendering.md: reference/api.md#mkdocstrings.handlers.rendering
190+
reference/inventory.md: reference/api.md#mkdocstrings.inventory
191+
reference/loggers.md: reference/api.md#mkdocstrings.loggers
192+
reference/plugin.md: reference/api.md#mkdocstrings.plugin
190193
- minify:
191194
minify_html: !ENV [DEPLOY, false]
192195
- group:

pyproject.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ getter = "scripts.get_version:get_version"
6666

6767
[tool.pdm.build]
6868
# Include as much as possible in the source distribution, to help redistributors.
69-
excludes = ["**/.pytest_cache"]
69+
excludes = ["**/.pytest_cache", "**/.mypy_cache"]
7070
source-includes = [
7171
"config",
7272
"docs",
@@ -112,7 +112,7 @@ ci = [
112112
"mkdocs>=1.6",
113113
"mkdocs-coverage>=1.0",
114114
"mkdocs-git-revision-date-localized-plugin>=1.2",
115-
"mkdocs-llmstxt>=0.1",
115+
"mkdocs-llmstxt>=0.2",
116116
"mkdocs-material>=9.5",
117117
"mkdocs-minify-plugin>=0.8",
118118
"mkdocs-redirects>=1.2.1",

tests/test_api.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,11 @@ def test_inventory_matches_api(
155155
public_api_paths = {obj.path for obj in public_objects}
156156
public_api_paths.add("mkdocstrings")
157157
for item in inventory.values():
158-
if item.domain == "py" and "(" not in item.name:
158+
if (
159+
item.domain == "py"
160+
and "(" not in item.name
161+
and (item.name == "mkdocstrings" or item.name.startswith("mkdocstrings."))
162+
):
159163
obj = loader.modules_collection[item.name]
160164
# YORE: Bump 1: Remove block.
161165
if any(obj.path.startswith(f"mkdocstrings.{module}") for module in deprecated_modules):

tests/test_extension.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,6 @@ def test_removing_duplicated_headings(ext_markdown: Markdown) -> None:
198198
assert output.count(">Heading one<") == 1
199199
assert output.count(">Heading two<") == 1
200200
assert output.count(">Heading three<") == 1
201-
assert output.count('class="mkdocstrings') == 0
202201

203202

204203
def _assert_contains_in_order(items: list[str], string: str) -> None:

0 commit comments

Comments
 (0)