Skip to content

Commit a51b71d

Browse files
committed
Deployed 32e415d with MkDocs version: 1.6.1
1 parent 98f9454 commit a51b71d

File tree

25 files changed

+107
-93
lines changed

25 files changed

+107
-93
lines changed

404.html

+1-1
Large diffs are not rendered by default.

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

+3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

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

-3
This file was deleted.

changelog/index.html

+3-3
Large diffs are not rendered by default.

code_of_conduct/index.html

+2-2
Large diffs are not rendered by default.

contributing/index.html

+2-2
Large diffs are not rendered by default.

coverage/covindex.html

Whitespace-only changes.

.coverage-tmp.html coverage/index.html

+3-3
Large diffs are not rendered by default.

credits/index.html

+2-2
Large diffs are not rendered by default.

index.html

+2-2
Large diffs are not rendered by default.

insiders/changelog/index.html

+2-2
Large diffs are not rendered by default.

insiders/index.html

+2-2
Large diffs are not rendered by default.

insiders/installation/index.html

+2-2
Large diffs are not rendered by default.

license/index.html

+2-2
Large diffs are not rendered by default.

llms-full.txt

+36-25
Original file line numberDiff line numberDiff line change
@@ -1539,7 +1539,7 @@ Classes:
15391539
- **`MkdocstringsExtension`** – Our Markdown extension.
15401540
- **`MkdocstringsInnerExtension`** – Extension that should always be added to Markdown sub-documents that handlers request (and only them).
15411541
- **`MkdocstringsPlugin`** – An mkdocs plugin.
1542-
- **`ParagraphStrippingTreeprocessor`** – Unwraps the element around the whole output.
1542+
- **`ParagraphStrippingTreeprocessor`** – Unwraps the <p> element around the whole output.
15431543
- **`PluginConfig`** – The configuration options of mkdocstrings, written in mkdocs.yml.
15441544
- **`TemplateLogger`** – A wrapper class to allow logging in templates.
15451545
- **`ThemeNotSupported`** – An exception raised to tell a theme is not supported.
@@ -1741,6 +1741,7 @@ Methods:
17411741
- **`get_templates_dir`** – Return the path to the handler's templates directory.
17421742
- **`load_inventory`** – Yield items and their URLs from an inventory file streamed from in_file.
17431743
- **`render`** – Render a template using provided data and configuration options.
1744+
- **`render_backlinks`** – Render backlinks.
17441745
- **`teardown`** – Teardown the handler.
17451746
- **`update_env`** – Update the Jinja environment.
17461747

@@ -1944,7 +1945,7 @@ Parameters:
19441945

19451946
- #### **`strip_paragraph`**
19461947

1947-
(`bool`, default: `False` ) – Whether to exclude the tag from around the whole output.
1948+
(`bool`, default: `False` ) – Whether to exclude the <p> tag from around the whole output.
19481949

19491950
Returns:
19501951

@@ -2165,6 +2166,17 @@ Returns:
21652166

21662167
- `str` – The rendered template as HTML.
21672168

2169+
### render_backlinks
2170+
2171+
```python
2172+
render_backlinks(
2173+
backlinks: Mapping[str, Iterable[Backlink]],
2174+
) -> str
2175+
2176+
```
2177+
2178+
Render backlinks.
2179+
21682180
### teardown
21692181

21702182
```python
@@ -3104,14 +3116,14 @@ Methods:
31043116

31053117
- **`get_handler`** – Get a handler by its name. See mkdocstrings.Handlers.get_handler.
31063118
- **`on_config`** – Instantiate our Markdown extension.
3107-
- **`on_env`** – Extra actions that need to happen after all Markdown rendering and before HTML rendering.
31083119
- **`on_post_build`** – Teardown the handlers.
31093120

31103121
Attributes:
31113122

31123123
- **`css_filename`** (`str`) – The path of the CSS file to write in the site directory.
31133124
- **`handlers`** (`Handlers`) – Get the instance of mkdocstrings.Handlers for this plugin/build.
31143125
- **`inventory_enabled`** (`bool`) – Tell if the inventory is enabled or not.
3126+
- **`on_env`** – Extra actions that need to happen after all Markdown-to-HTML page rendering.
31153127
- **`plugin_enabled`** (`bool`) – Tell if the plugin is enabled or not.
31163128

31173129
### css_filename
@@ -3153,6 +3165,26 @@ Returns:
31533165

31543166
- `bool` – Whether the inventory is enabled.
31553167

3168+
### on_env
3169+
3170+
```python
3171+
on_env = CombinedEvent(
3172+
_on_env_load_inventories,
3173+
_on_env_add_css,
3174+
_on_env_write_inventory,
3175+
_on_env_apply_backlinks,
3176+
)
3177+
3178+
```
3179+
3180+
Extra actions that need to happen after all Markdown-to-HTML page rendering.
3181+
3182+
Hook for the [`on_env` event](https://www.mkdocs.org/user-guide/plugins/#on_env).
3183+
3184+
- Gather results from background inventory download tasks.
3185+
- Write mkdocstrings' extra files (CSS, inventory) into the site directory.
3186+
- Apply backlinks to the HTML output of each page.
3187+
31563188
### plugin_enabled
31573189

31583190
```python
@@ -3208,25 +3240,6 @@ Returns:
32083240

32093241
- `MkDocsConfig | None` – The modified config.
32103242

3211-
### on_env
3212-
3213-
```python
3214-
on_env(
3215-
env: Environment,
3216-
config: MkDocsConfig,
3217-
*args: Any,
3218-
**kwargs: Any,
3219-
) -> None
3220-
3221-
```
3222-
3223-
Extra actions that need to happen after all Markdown rendering and before HTML rendering.
3224-
3225-
Hook for the [`on_env` event](https://www.mkdocs.org/user-guide/plugins/#on_env).
3226-
3227-
- Write mkdocstrings' extra files into the site dir.
3228-
- Gather results from background inventory download tasks.
3229-
32303243
### on_post_build
32313244

32323245
```python
@@ -3254,9 +3267,7 @@ Parameters:
32543267

32553268
Bases: `Treeprocessor`
32563269

3257-
Unwraps the
3258-
3259-
element around the whole output.
3270+
Unwraps the `<p>` element around the whole output.
32603271

32613272
Methods:
32623273

objects.inv

24 Bytes
Binary file not shown.

recipes/index.html

+2-2
Large diffs are not rendered by default.

reference/mkdocstrings/index.html

+18-15
Large diffs are not rendered by default.

search/search_index.json

+1-1
Large diffs are not rendered by default.

sitemap.xml

+16-16
Original file line numberDiff line numberDiff line change
@@ -2,66 +2,66 @@
22
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
33
<url>
44
<loc>https://mkdocstrings.github.io/</loc>
5-
<lastmod>2025-03-09</lastmod>
5+
<lastmod>2025-03-10</lastmod>
66
</url>
77
<url>
88
<loc>https://mkdocstrings.github.io/changelog/</loc>
9-
<lastmod>2025-03-09</lastmod>
9+
<lastmod>2025-03-10</lastmod>
1010
</url>
1111
<url>
1212
<loc>https://mkdocstrings.github.io/code_of_conduct/</loc>
13-
<lastmod>2025-03-09</lastmod>
13+
<lastmod>2025-03-10</lastmod>
1414
</url>
1515
<url>
1616
<loc>https://mkdocstrings.github.io/contributing/</loc>
17-
<lastmod>2025-03-09</lastmod>
17+
<lastmod>2025-03-10</lastmod>
1818
</url>
1919
<url>
2020
<loc>https://mkdocstrings.github.io/credits/</loc>
21-
<lastmod>2025-03-09</lastmod>
21+
<lastmod>2025-03-10</lastmod>
2222
</url>
2323
<url>
2424
<loc>https://mkdocstrings.github.io/license/</loc>
25-
<lastmod>2025-03-09</lastmod>
25+
<lastmod>2025-03-10</lastmod>
2626
</url>
2727
<url>
2828
<loc>https://mkdocstrings.github.io/recipes/</loc>
29-
<lastmod>2025-03-09</lastmod>
29+
<lastmod>2025-03-10</lastmod>
3030
</url>
3131
<url>
3232
<loc>https://mkdocstrings.github.io/troubleshooting/</loc>
33-
<lastmod>2025-03-09</lastmod>
33+
<lastmod>2025-03-10</lastmod>
3434
</url>
3535
<url>
3636
<loc>https://mkdocstrings.github.io/insiders/</loc>
37-
<lastmod>2025-03-09</lastmod>
37+
<lastmod>2025-03-10</lastmod>
3838
</url>
3939
<url>
4040
<loc>https://mkdocstrings.github.io/insiders/changelog/</loc>
41-
<lastmod>2025-03-09</lastmod>
41+
<lastmod>2025-03-10</lastmod>
4242
</url>
4343
<url>
4444
<loc>https://mkdocstrings.github.io/insiders/installation/</loc>
45-
<lastmod>2025-03-09</lastmod>
45+
<lastmod>2025-03-10</lastmod>
4646
</url>
4747
<url>
4848
<loc>https://mkdocstrings.github.io/reference/mkdocstrings/</loc>
49-
<lastmod>2025-03-09</lastmod>
49+
<lastmod>2025-03-10</lastmod>
5050
</url>
5151
<url>
5252
<loc>https://mkdocstrings.github.io/usage/</loc>
53-
<lastmod>2025-03-09</lastmod>
53+
<lastmod>2025-03-10</lastmod>
5454
</url>
5555
<url>
5656
<loc>https://mkdocstrings.github.io/usage/handlers/</loc>
57-
<lastmod>2025-03-09</lastmod>
57+
<lastmod>2025-03-10</lastmod>
5858
</url>
5959
<url>
6060
<loc>https://mkdocstrings.github.io/usage/theming/</loc>
61-
<lastmod>2025-03-09</lastmod>
61+
<lastmod>2025-03-10</lastmod>
6262
</url>
6363
<url>
6464
<loc>https://mkdocstrings.github.io/coverage/</loc>
65-
<lastmod>2025-03-09</lastmod>
65+
<lastmod>2025-03-10</lastmod>
6666
</url>
6767
</urlset>

sitemap.xml.gz

0 Bytes
Binary file not shown.

troubleshooting/index.html

+2-2
Large diffs are not rendered by default.

usage/handlers/index.html

+2-2
Large diffs are not rendered by default.

usage/index.html

+2-2
Large diffs are not rendered by default.

usage/theming/index.html

+2-2
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)