Skip to content

Commit b0b813a

Browse files
committed
style: Remove trailing spaces
1 parent 83823be commit b0b813a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

52 files changed

+100
-100
lines changed

CHANGELOG.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -227,12 +227,12 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
227227

228228
- Release Insiders features of the $500/month funding goal ([bd30106](https://github.com/mkdocstrings/python/commit/bd301061fe9c647f9b91c2c9b4baa784c304eca7) by Timothée Mazzucotelli).
229229
The features and projects related to *mkdocstrings-python* are:
230-
230+
231231
- [Cross-references for type annotations in signatures](https://mkdocstrings.github.io/python/usage/configuration/signatures/#signature_crossrefs)
232232
- [Symbol types in headings and table of contents](https://mkdocstrings.github.io/python/usage/configuration/headings/#show_symbol_type_toc)
233233
- [`griffe-inherited-docstrings`](https://mkdocstrings.github.io/griffe-inherited-docstrings/), a Griffe extension for inheriting docstrings
234234
- [`griffe2md`](https://mkdocstrings.github.io/griffe2md/), a tool to output API docs to Markdown using Griffe
235-
235+
236236
See the complete list of features and projects here:
237237
https://pawamoy.github.io/insiders/#500-plasmavac-user-guide.
238238

@@ -464,7 +464,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
464464

465465
You can see how to use the filter in this commit's changes:
466466
[f686f4e4](https://github.com/mkdocstrings/python/commit/f686f4e4599cea64686d4ef4863b507dd096a513).
467-
467+
468468
**We take this as an opportunity to go out of beta and bump the version to 1.0.0.
469469
This will allow users to rely on semantic versioning.**
470470

docs/.glossary.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[Griffe]: https://github.com/mkdocstrings/griffe
77
[ReadTheDocs Sphinx theme]: https://sphinx-rtd-theme.readthedocs.io/en/stable/index.html
88
[Spacy's documentation]: https://spacy.io/api/doc/
9-
[Black]: https://pypi.org/project/black/
9+
[Black]: https://pypi.org/project/black/
1010
[Material for MkDocs]: https://squidfunk.github.io/mkdocs-material
1111
[Ruff]: https://docs.astral.sh/ruff
1212

docs/.overrides/main.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
{% extends "base.html" %}
22

33
{% block announce %}
4-
4+
55
<strong>Fund this project</strong> through
66
<a href="{{ 'insiders/#how-to-become-a-sponsor' | url }}"><strong>sponsorship</strong></a>
77
<span class="twemoji heart pulse">
88
{% include ".icons/octicons/heart-fill-16.svg" %}
99
</span> &mdash;
10-
10+
1111
Follow
1212
<strong>@pawamoy</strong> on
1313
<a rel="me" href="https://fosstodon.org/@pawamoy">

docs/.overrides/partials/comments.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ <h2 id="__comments">Feedback</h2>
3131
: "light"
3232

3333
// Instruct Giscus to set theme
34-
giscus.setAttribute("data-theme", theme)
34+
giscus.setAttribute("data-theme", theme)
3535
}
3636

3737
// Register event handlers after documented loaded

docs/insiders/index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ You can cancel your sponsorship anytime.[^5]
161161

162162
The following section lists all funding goals. Each goal contains a list of
163163
features prefixed with a checkmark symbol, denoting whether a feature is
164-
:octicons-check-circle-fill-24:{ style="color: #00e676" } already available or
164+
:octicons-check-circle-fill-24:{ style="color: #00e676" } already available or
165165
:octicons-check-circle-fill-24:{ style="color: var(--md-default-fg-color--lightest)" } planned,
166166
but not yet implemented. When the funding goal is hit,
167167
the features are released for general availability.
@@ -221,7 +221,7 @@ by the [ISC License][license]. However, we kindly ask you to respect our
221221

222222
- Please **don't distribute the source code** of Insiders. You may freely use
223223
it for public, private or commercial projects, privately fork or mirror it,
224-
but please don't make the source code public, as it would counteract the
224+
but please don't make the source code public, as it would counteract the
225225
sponsorware strategy.
226226

227227
- If you cancel your subscription, you're automatically removed as a

docs/insiders/installation.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -42,21 +42,21 @@ Or using HTTPS:
4242
pip install git+https://${GH_TOKEN}@github.com/pawamoy-insiders/mkdocstrings-python.git
4343
```
4444

45-
>? NOTE: **How to get a GitHub personal access token**
45+
>? NOTE: **How to get a GitHub personal access token?**
4646
> The `GH_TOKEN` environment variable is a GitHub token.
4747
> It can be obtained by creating a [personal access token] for
4848
> your GitHub account. It will give you access to the Insiders repository,
4949
> programmatically, from the command line or GitHub Actions workflows:
50-
>
50+
>
5151
> 1. Go to https://github.com/settings/tokens
5252
> 2. Click on [Generate a new token]
5353
> 3. Enter a name and select the [`repo`][scopes] scope
5454
> 4. Generate the token and store it in a safe place
55-
>
55+
>
5656
> [personal access token]: https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token
5757
> [Generate a new token]: https://github.com/settings/tokens/new
5858
> [scopes]: https://docs.github.com/en/developers/apps/scopes-for-oauth-apps#available-scopes
59-
>
59+
>
6060
> Note that the personal access
6161
> token must be kept secret at all times, as it allows the owner to access your
6262
> private repositories.

docs/usage/configuration/general.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -274,7 +274,7 @@ plugins:
274274
::: your_package.your_module
275275
options:
276276
preload_modules:
277-
- their_package
277+
- their_package
278278
```
279279

280280
```python title="your_package/your_module.py"

docs/usage/configuration/headings.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -286,15 +286,15 @@ More text.
286286
type: preview
287287

288288
//// tab | With ToC entry
289-
**Table of contents**
290-
[Some heading](#permalink-to-some-heading){ title="#permalink-to-some-heading" }
291-
[`object`](#permalink-to-object){ title="#permalink-to-object" }
292-
[Other heading](#permalink-to-other-heading){ title="#permalink-to-other-heading" }
289+
**Table of contents**
290+
[Some heading](#permalink-to-some-heading){ title="#permalink-to-some-heading" }
291+
[`object`](#permalink-to-object){ title="#permalink-to-object" }
292+
[Other heading](#permalink-to-other-heading){ title="#permalink-to-other-heading" }
293293
////
294294

295295
//// tab | Without ToC entry
296-
**Table of contents**
297-
[Some heading](#permalink-to-some-heading){ title="#permalink-to-some-heading" }
296+
**Table of contents**
297+
[Some heading](#permalink-to-some-heading){ title="#permalink-to-some-heading" }
298298
[Other heading](#permalink-to-other-heading){ title="#permalink-to-other-heading" }
299299
////
300300
///
@@ -400,7 +400,7 @@ plugins:
400400
Show the full Python path of every object.
401401

402402
Same as for [`show_root_members_full_path`][],
403-
but for every member, recursively. This option takes precedence over
403+
but for every member, recursively. This option takes precedence over
404404
[`show_root_members_full_path`][]:
405405

406406
`show_root_members_full_path` | `show_object_full_path` | Direct root members path
@@ -454,7 +454,7 @@ When [grouped by categories][group_by_category], show a heading for each categor
454454
These category headings will appear in the table of contents,
455455
allowing you to link to them using their permalinks.
456456

457-
WARNING: **Not recommended with deeply nested object**
457+
WARNING: **Not recommended with deeply nested objects.**
458458
When injecting documentation for deeply nested objects,
459459
you'll quickly run out of heading levels, and the objects
460460
at the bottom of the tree risk all getting documented

docs/usage/configuration/signatures.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@ plugins:
202202

203203
[:octicons-heart-fill-24:{ .pulse } Sponsors only](../../insiders/index.md){ .insiders } &mdash;
204204
[:octicons-tag-24: Insiders 1.8.0](../../insiders/changelog.md#1.8.0) &mdash;
205-
**This feature also requires
205+
**This feature also requires
206206
[Griffe Insiders](https://mkdocstrings.github.io/griffe/insiders/)
207207
to be installed.**
208208

docs/usage/customization.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -371,9 +371,9 @@ Available context:
371371
#### Docstring sections
372372

373373
In `docstring/attributes.html`,
374-
`docstring/functions.html`,
375-
`docstring/classes.html`,
376-
`docstring/modules.html`,
374+
`docstring/functions.html`,
375+
`docstring/classes.html`,
376+
`docstring/modules.html`,
377377
`docstring/other_parameters.html`,
378378
`docstring/parameters.html`,
379379
`docstring/raises.html`,

docs/usage/docstrings/google.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,11 @@ For example:
1717
This admonition has a custom title!
1818
"""
1919
```
20-
20+
2121
=== "Result"
2222
NOTE: It looks like a section, but it will be rendered as an admonition.
2323

24-
TIP: **You can even choose a title.**
24+
TIP: **You can even choose a title.**
2525
This admonition has a custom title!
2626

2727
See [Napoleon's documentation](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html).

docs/usage/index.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Usage
22

3-
TIP: **This is the documentation for the NEW Python handler.**
3+
TIP: **This is the documentation for the NEW Python handler.**
44
To read the documentation for the LEGACY handler,
55
go to the [legacy handler documentation](https://mkdocstrings.github.io/python-legacy).
66

@@ -94,7 +94,7 @@ When importing an inventory, you enable automatic cross-references
9494
to other documentation sites like the standard library docs
9595
or any third-party package docs. Typically, you want to import
9696
the inventories of your project's dependencies, at least those
97-
that are used in the public API.
97+
that are used in the public API.
9898

9999
See [*mkdocstrings*' documentation on inventories][inventories]
100100
for more details.
@@ -292,7 +292,7 @@ to make sure anyone can build your docs from any location on their filesystem.
292292

293293
### Using the PYTHONPATH environment variable
294294

295-
WARNING: **This method has limitations.**
295+
WARNING: **This method has limitations.**
296296
This method might work for you, with your current setup,
297297
but not for others trying your build your docs with their own setup/environment.
298298
We recommend using the [`paths` method](#using-the-paths-option) instead.
@@ -348,10 +348,10 @@ In Bash and other shells, you can run your command like this
348348
```bash
349349
PYTHONPATH=src mkdocs build -f docs/mkdocs.yml
350350
```
351-
351+
352352
### Installing your package in the current Python environment
353353

354-
WARNING: **This method has limitations.**
354+
WARNING: **This method has limitations.**
355355
This method might work for you, with your current setup,
356356
but not for others trying your build your docs with their own setup/environment.
357357
We recommend using the [`paths` method](#using-the-paths-option) instead.

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

+6-6
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Context:
1212

1313
{% block logs scoped %}
1414
{#- Logging block.
15-
15+
1616
This block can be used to log debug messages, deprecation messages, warnings, etc.
1717
-#}
1818
{{ log.debug("Rendering " + attribute.path) }}
@@ -44,7 +44,7 @@ Context:
4444

4545
{% block heading scoped %}
4646
{#- Heading block.
47-
47+
4848
This block renders the heading for the attribute.
4949
-#}
5050
{% if config.show_symbol_type_heading %}<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code>{% endif %}
@@ -60,7 +60,7 @@ Context:
6060

6161
{% block labels scoped %}
6262
{#- Labels block.
63-
63+
6464
This block renders the labels for the attribute.
6565
-#}
6666
{% with labels = attribute.labels %}
@@ -72,7 +72,7 @@ Context:
7272

7373
{% block signature scoped %}
7474
{#- Signature block.
75-
75+
7676
This block renders the signature for the attribute.
7777
-#}
7878
{% if config.separate_signature %}
@@ -99,14 +99,14 @@ Context:
9999
<div class="doc doc-contents {% if root %}first{% endif %}">
100100
{% block contents scoped %}
101101
{#- Contents block.
102-
102+
103103
This block renders the contents of the attribute.
104104
It contains other blocks that users can override.
105105
Overriding the contents block allows to rearrange the order of the blocks.
106106
-#}
107107
{% block docstring scoped %}
108108
{#- Docstring block.
109-
109+
110110
This block renders the docstring for the attribute.
111111
-#}
112112
{% with docstring_sections = attribute.docstring.parsed %}

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Context:
1313
{% if obj.all_members %}
1414
{% block logs scoped %}
1515
{#- Logging block.
16-
16+
1717
This block can be used to log debug messages, deprecation messages, warnings, etc.
1818
-#}
1919
{{ log.debug("Rendering children of " + obj.path) }}

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

+10-10
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Context:
1111

1212
{% block logs scoped %}
1313
{#- Logging block.
14-
14+
1515
This block can be used to log debug messages, deprecation messages, warnings, etc.
1616
-#}
1717
{{ log.debug("Rendering " + class.path) }}
@@ -43,7 +43,7 @@ Context:
4343

4444
{% block heading scoped %}
4545
{#- Heading block.
46-
46+
4747
This block renders the heading for the class.
4848
-#}
4949
{% if config.show_symbol_type_heading %}<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code>{% endif %}
@@ -62,7 +62,7 @@ Context:
6262

6363
{% block labels scoped %}
6464
{#- Labels block.
65-
65+
6666
This block renders the labels for the class.
6767
-#}
6868
{% with labels = class.labels %}
@@ -74,7 +74,7 @@ Context:
7474

7575
{% block signature scoped %}
7676
{#- Signature block.
77-
77+
7878
This block renders the signature for the class.
7979
Overloads of the `__init__` method are rendered if `merge_init_into_class` is enabled.
8080
The actual `__init__` method signature is only rendered if `separate_signature` is also enabled.
@@ -117,14 +117,14 @@ Context:
117117
<div class="doc doc-contents {% if root %}first{% endif %}">
118118
{% block contents scoped %}
119119
{#- Contents block.
120-
120+
121121
This block renders the contents of the class.
122122
It contains other blocks that users can override.
123123
Overriding the contents block allows to rearrange the order of the blocks.
124124
-#}
125125
{% block bases scoped %}
126126
{#- Class bases block.
127-
127+
128128
This block renders the bases for the class.
129129
-#}
130130
{% if config.show_bases and class.bases %}
@@ -138,7 +138,7 @@ Context:
138138

139139
{% block docstring scoped %}
140140
{#- Docstring block.
141-
141+
142142
This block renders the docstring for the class.
143143
-#}
144144
{% with docstring_sections = class.docstring.parsed %}
@@ -161,15 +161,15 @@ Context:
161161

162162
{% block summary scoped %}
163163
{#- Summary block.
164-
164+
165165
This block renders auto-summaries for classes, methods, and attributes.
166166
-#}
167167
{% include "summary"|get_template with context %}
168168
{% endblock summary %}
169169

170170
{% block source scoped %}
171171
{#- Source block.
172-
172+
173173
This block renders the source code for the class.
174174
-#}
175175
{% if config.show_source %}
@@ -205,7 +205,7 @@ Context:
205205

206206
{% block children scoped %}
207207
{#- Children block.
208-
208+
209209
This block renders the children (members) of the class.
210210
-#}
211211
{% set root = False %}

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Context:
1414
{% if docstring_sections %}
1515
{% block logs scoped %}
1616
{#- Logging block.
17-
17+
1818
This block can be used to log debug messages, deprecation messages, warnings, etc.
1919
-#}
2020
{{ log.debug("Rendering docstring") }}

src/mkdocstrings_handlers/python/templates/material/_base/docstring/admonition.html.jinja

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Context:
88

99
{% block logs scoped %}
1010
{#- Logging block.
11-
11+
1212
This block can be used to log debug messages, deprecation messages, warnings, etc.
1313
-#}
1414
{{ log.debug("Rendering admonition") }}

0 commit comments

Comments
 (0)