docs: Lint docs

Author: pawamoy

docs/usage/configuration/docstrings.md

@@ -214,8 +214,8 @@ In that case, the Spacy tables can help.
 
 **Type**   | **Name**    | **Description**          | **Default**
 ---------- | ----------- | ------------------------ | -----------
-<code><autoref identifier="list" optional>list</autoref>[<autoref identifier="int" optional>int</autoref> \| <autoref identifier="float" optional>float</autoref>]</code> | `gravity_forces` | Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. | *required*
-<code><autoref identifier="VacuumType" optional>VacuumType</autoref> \| <autoref identifier="typing.Literal" optional>Literal</autoref>["regular"]</code> | `vacuum_type` | Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. | `VacuumType.PLASMA`
+<code><autoref identifier="list" optional>list</autoref>\[<autoref identifier="int" optional>int</autoref> \| <autoref identifier="float" optional>float</autoref>\]</code> | `gravity_forces` | Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. | *required*
+<code><autoref identifier="VacuumType" optional>VacuumType</autoref> \| <autoref identifier="typing.Literal" optional>Literal</autoref>\["regular"\]</code> | `vacuum_type` | Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. | `VacuumType.PLASMA`
 ////
 
 //// tab | List
@@ -228,8 +228,8 @@ Lists work well whatever the length of names, type annotations, descriptions, et
 
 **Other Parameters:**
 
-- `gravity_forces` (<code><autoref identifier="list" optional>list</autoref>[<autoref identifier="int" optional>int</autoref> \| <autoref identifier="float" optional>float</autoref>]</code>) &mdash; Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
-- `vacuum_type` (<code><autoref identifier="VacuumType" optional>VacuumType</autoref> \| <autoref identifier="typing.Literal" optional>Literal</autoref>["regular"]</code>) &mdash; Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+- `gravity_forces` (<code><autoref identifier="list" optional>list</autoref>\[<autoref identifier="int" optional>int</autoref> \| <autoref identifier="float" optional>float</autoref>\]</code>) &mdash; Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+- `vacuum_type` (<code><autoref identifier="VacuumType" optional>VacuumType</autoref> \| <autoref identifier="typing.Literal" optional>Literal</autoref>\["regular"\]</code>) &mdash; Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
 ////
 
 //// tab | Spacy
@@ -247,8 +247,8 @@ by reserving more horizontal space on the second column.
 
 **Name**    | **Description**
 ----------- | ---------------
-`gravity_forces` | Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.<br>**TYPE:** <code><autoref identifier="list" optional>list</autoref>[<autoref identifier="int" optional>int</autoref> \| <autoref identifier="float" optional>float</autoref>]</code> <span style="float: right;"><b>DEFAULT:</b> <i>required</i></span>
-`vacuum_type` | Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.<br>**TYPE:**<code><autoref identifier="VacuumType" optional>VacuumType</autoref> \| <autoref identifier="typing.Literal" optional>Literal</autoref>["regular"]</code> <span style="float: right;"><b>DEFAULT:</b> <code>VacuumType.PLASMA</code></span>
+`gravity_forces` | Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.<br>**TYPE:** <code><autoref identifier="list" optional>list</autoref>\[<autoref identifier="int" optional>int</autoref> \| <autoref identifier="float" optional>float</autoref>\]</code> <span style="float: right;"><b>DEFAULT:</b> <i>required</i></span>
+`vacuum_type` | Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.<br>**TYPE:**<code><autoref identifier="VacuumType" optional>VacuumType</autoref> \| <autoref identifier="typing.Literal" optional>Literal</autoref>\["regular"\]</code> <span style="float: right;"><b>DEFAULT:</b> <code>VacuumType.PLASMA</code></span>
 ////
 ///
 

docs/usage/configuration/general.md

@@ -63,7 +63,7 @@ plugins:
 [](){#option-backlinks}
 ## `backlinks`
 
-- **:octicons-package-24: Type <code><autoref identifier="typing.Literal" optional>Literal</autoref>["flat", "tree", False]</code> :material-equal: `False`{ title="default value" }**
+- **:octicons-package-24: Type <code><autoref identifier="typing.Literal" optional>Literal</autoref>\["flat", "tree", False\]</code> :material-equal: `False`{ title="default value" }**
 
 The `backlinks` option enables rendering of backlinks within your API documentation.
 
@@ -102,7 +102,7 @@ plugins:
 [](){#option-extensions}
 ## `extensions`
 
-- **:octicons-package-24: Type <code><autoref identifier="list" optional>list</autoref>[<autoref identifier="str" optional>str</autoref> | <autoref identifier="dict" optional>dict</autoref>[<autoref identifier="str" optional>str</autoref>, <autoref identifier="dict" optional>dict</autoref>[<autoref identifier="str" optional>str</autoref>, <autoref identifier="typing.Any" optional>Any</autoref>]]]</code> :material-equal: `[]`{ title="default value" }**
+- **:octicons-package-24: Type <code><autoref identifier="list" optional>list</autoref>\[<autoref identifier="str" optional>str</autoref> | <autoref identifier="dict" optional>dict</autoref>\[<autoref identifier="str" optional>str</autoref>, <autoref identifier="dict" optional>dict</autoref>\[<autoref identifier="str" optional>str</autoref>, <autoref identifier="typing.Any" optional>Any</autoref>\]\]\]</code> :material-equal: `[]`{ title="default value" }**
 <!-- - **:octicons-project-template-24: Template :material-null:** (contained in [`class.html`][class template]) -->
 
 The `extensions` option lets you enable [Griffe extensions](https://mkdocstrings.github.io/griffe/extensions/), which enhance or modify the data collected from Python sources (or compiled modules).
@@ -406,7 +406,7 @@ Mixin2A --> Mixin2B
 [](){#option-preload_modules}
 ## `preload_modules`
 
-- **:octicons-package-24: Type <code><autoref identifier="list" optional>list</autoref>[<autoref identifier="str" optional>str</autoref>] | None</code>  :material-equal: `None`{ title="default value" }**
+- **:octicons-package-24: Type <code><autoref identifier="list" optional>list</autoref>\[<autoref identifier="str" optional>str</autoref>\] | None</code>  :material-equal: `None`{ title="default value" }**
 <!-- - **:octicons-project-template-24: Template :material-null:** (N/A) -->
 
 Pre-load modules that are not specified directly in [autodoc instructions][autodoc syntax] (`::: identifier`).

docs/usage/configuration/headings.md

@@ -191,7 +191,7 @@ plugins:
 <code class="doc-symbol doc-symbol-toc doc-symbol-function"></code> get_version<br>
 <code class="doc-symbol doc-symbol-toc doc-symbol-parameter" style="margin-left: 16px;"></code> dist
 
-To customize symbols, see [Customizing symbol types](../customization.md/#symbol-types).
+To customize symbols, see [Customizing symbol types](../customization.md#symbol-types).
 
 ///
 
@@ -303,6 +303,10 @@ More text.
 /// admonition | Preview
     type: preview
 
+[](){#permalink-to-some-heading}
+[](){#permalink-to-object}
+[](){#permalink-to-other-heading}
+
 //// tab | With ToC entry
 **Table of contents**
 [Some heading](#permalink-to-some-heading){ title="#permalink-to-some-heading" }
@@ -548,7 +552,7 @@ This option will prefix headings with
 <code class="doc-symbol doc-symbol-module"></code> types.
 See also [`show_symbol_type_toc`][show_symbol_type_toc].
 
-To customize symbols, see [Customizing symbol types](../customization.md/#symbol-types).
+To customize symbols, see [Customizing symbol types](../customization.md#symbol-types).
 
 ```yaml title="in mkdocs.yml (global configuration)"
 plugins:
@@ -611,7 +615,7 @@ This option will prefix items in the ToC with
 <code class="doc-symbol doc-symbol-module"></code> types.
 See also [`show_symbol_type_heading`][show_symbol_type_heading].
 
-To customize symbols, see [Customizing symbol types](../customization.md/#symbol-types).
+To customize symbols, see [Customizing symbol types](../customization.md#symbol-types).
 
 ```yaml title="in mkdocs.yml (global configuration)"
 plugins:

docs/usage/configuration/members.md

@@ -3,7 +3,7 @@
 [](){#option-members}
 ## `members`
 
-- **:octicons-package-24: Type <code><autoref identifier="list" optional>list</autoref>[<autoref identifier="str" optional>str</autoref>] |
+- **:octicons-package-24: Type <code><autoref identifier="list" optional>list</autoref>\[<autoref identifier="str" optional>str</autoref>\] |
     <autoref identifier="bool" optional>bool</autoref> | None</code>  :material-equal: `None`{ title="default value" }**
 <!-- - **:octicons-project-template-24: Template :material-null:** (N/A) -->
 
@@ -99,7 +99,7 @@ INFO: **The default behavior (with unspecified `members` or `members: null`) is
 [](){#option-inherited_members}
 ## `inherited_members`
 
-- **:octicons-package-24: Type <code><autoref identifier="list" optional>list</autoref>[<autoref identifier="str" optional>str</autoref>] |
+- **:octicons-package-24: Type <code><autoref identifier="list" optional>list</autoref>\[<autoref identifier="str" optional>str</autoref>\] |
     <autoref identifier="bool" optional>bool</autoref></code>  :material-equal: `False`{ title="default value" }**
 <!-- - **:octicons-project-template-24: Template :material-null:** (N/A) -->
 
@@ -342,7 +342,7 @@ def function_c():
 [](){#option-filters}
 ## `filters`
 
-- **:octicons-package-24: Type <code><autoref identifier="list" optional>list</autoref>[<autoref identifier="str" optional>str</autoref>] | <autoref identifier="typing.Literal" optional>Literal</autoref>["public"] | None</code>  :material-equal: `["!^_[^_]"]`{ title="default value" }**
+- **:octicons-package-24: Type <code><autoref identifier="list" optional>list</autoref>\[<autoref identifier="str" optional>str</autoref>\] | <autoref identifier="typing.Literal" optional>Literal</autoref>\["public"\] | None</code>  :material-equal: `["!^_[^_]"]`{ title="default value" }**
 <!-- - **:octicons-project-template-24: Template :material-null:** (N/A) -->
 
 A list of filters, or `"public"`.
@@ -574,7 +574,7 @@ package
 [](){#option-summary}
 ## `summary`
 
-- **:octicons-package-24: Type <code><autoref identifier="bool" optional>bool</autoref> | <autoref identifier="dict" optional>dict</autoref>[<autoref identifier="str" optional>str</autoref>, <autoref identifier="bool" optional>bool</autoref>]</code>  :material-equal: `False`{ title="default value" }**
+- **:octicons-package-24: Type <code><autoref identifier="bool" optional>bool</autoref> | <autoref identifier="dict" optional>dict</autoref>\[<autoref identifier="str" optional>str</autoref>, <autoref identifier="bool" optional>bool</autoref>\]</code>  :material-equal: `False`{ title="default value" }**
 <!-- - **:octicons-project-template-24: Template :material-null:** (N/A) -->
 
 Whether to render summaries of modules, classes, functions (methods) and attributes.

docs/usage/configuration/signatures.md

@@ -64,13 +64,17 @@ def convert(text: str, md: markdown.Markdown) -> markupsafe.Markup:
 <p>Convert text to Markdown.</p>
 <p><b>Parameters:</b></p>
 
+[](){#ref-to-markdown}
+
 **Type**   | **Description**          | **Default**
 ---------- | ------------------------ | -----------
 [`str`][]  | The text to convert.     | *required*
 [`Markdown`](#ref-to-markdown){ .external title="markdown.Markdown" } | A Markdown instance. | *required*
 
 <p><b>Returns:</b></p>
 
+[](){#ref-to-markup}
+
 **Type**   | **Name**    | **Description**
 ---------- | ----------- | ---------------
 [`Markup`](#ref-to-markup){ .external title="markupsafe.Markup" } | `text` | Converted markup.