Skip to content

Commit 6354622

Browse files
committed
docs: Remove Insiders links
1 parent c086b03 commit 6354622

File tree

8 files changed

+2
-39
lines changed

8 files changed

+2
-39
lines changed

CHANGELOG.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -487,9 +487,6 @@ Importing from submodules is now deprecated: the public API is fully exposed und
487487
- [`griffe-inherited-docstrings`](https://mkdocstrings.github.io/griffe-inherited-docstrings/), a Griffe extension for inheriting docstrings
488488
- [`griffe2md`](https://mkdocstrings.github.io/griffe2md/), a tool to output API docs to Markdown using Griffe
489489

490-
See the complete list of features and projects here:
491-
https://pawamoy.github.io/insiders/#500-plasmavac-user-guide.
492-
493490
## [1.7.5](https://github.com/mkdocstrings/python/releases/tag/1.7.5) - 2023-11-21
494491

495492
<small>[Compare with 1.7.4](https://github.com/mkdocstrings/python/compare/1.7.4...1.7.5)</small>

docs/usage/configuration/docstrings.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -327,9 +327,6 @@ class Thing:
327327
[](){#option-relative_crossrefs}
328328
## `relative_crossrefs`
329329

330-
[:octicons-heart-fill-24:{ .pulse } Sponsors only](../../insiders/index.md){ .insiders } &mdash;
331-
[:octicons-tag-24: Insiders 1.9.0](../../insiders/changelog.md#1.9.0)
332-
333330
- **:octicons-package-24: Type [`bool`][] :material-equal: `False`{ title="default value" }**
334331
<!-- - **:octicons-project-template-24: Template :material-null:** (N/A) -->
335332

@@ -440,9 +437,6 @@ INFO: **There is an alternative, third-party Python handler that handles relativ
440437
[](){#option-scoped_crossrefs}
441438
## `scoped_crossrefs`
442439
443-
[:octicons-heart-fill-24:{ .pulse } Sponsors only](../../insiders/index.md){ .insiders } &mdash;
444-
[:octicons-tag-24: Insiders 1.9.0](../../insiders/changelog.md#1.9.0)
445-
446440
- **:octicons-package-24: Type [`bool`][] :material-equal: `False`{ title="default value" }**
447441
<!-- - **:octicons-project-template-24: Template :material-null:** (N/A) -->
448442

docs/usage/configuration/general.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -63,9 +63,6 @@ plugins:
6363
[](){#option-backlinks}
6464
## `backlinks`
6565

66-
[:octicons-heart-fill-24:{ .pulse } Sponsors only](../../insiders/index.md){ .insiders } &mdash;
67-
[:octicons-tag-24: Insiders 1.10.0](../../insiders/changelog.md#1.10.0)
68-
6966
- **:octicons-package-24: Type <code><autoref identifier="typing.Literal" optional>Literal</autoref>["flat", "tree", False]</code> :material-equal: `False`{ title="default value" }**
7067

7168
The `backlinks` option enables rendering of backlinks within your API documentation.
@@ -503,9 +500,6 @@ plugins:
503500
[](){#option-show_inheritance_diagram}
504501
## `show_inheritance_diagram`
505502

506-
[:octicons-heart-fill-24:{ .pulse } Sponsors only](../../insiders/index.md){ .insiders } &mdash;
507-
[:octicons-tag-24: Insiders 1.7.0](../../insiders/changelog.md#1.7.0)
508-
509503
- **:octicons-package-24: Type [`bool`][] :material-equal: `False`{ title="default value" }**
510504
<!-- - **:octicons-project-template-24: Template :material-null:** (contained in [`class.html`][class template]) -->
511505

docs/usage/configuration/headings.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -77,8 +77,6 @@ plugins:
7777
[](){#option-parameter_headings}
7878
## `parameter_headings`
7979

80-
[:octicons-tag-24: Insiders 1.6.0](../../insiders/changelog.md#1.6.0)
81-
8280
- **:octicons-package-24: Type [`bool`][] :material-equal: `False`{ title="default value" }**
8381
<!-- - **:octicons-project-template-24: Template :material-null:** (N/A) -->
8482

@@ -537,8 +535,6 @@ plugins:
537535
[](){#option-show_symbol_type_heading}
538536
## `show_symbol_type_heading`
539537

540-
[:octicons-tag-24: Insiders 1.1.0](../../insiders/changelog.md#1.1.0)
541-
542538
- **:octicons-package-24: Type [`bool`][] :material-equal: `False`{ title="default value" }**
543539
<!-- - **:octicons-project-template-24: Template :material-null:** (N/A) -->
544540

@@ -602,8 +598,6 @@ plugins:
602598
[](){#option-show_symbol_type_toc}
603599
## `show_symbol_type_toc`
604600

605-
[:octicons-tag-24: Insiders 1.1.0](../../insiders/changelog.md#1.1.0)
606-
607601
- **:octicons-package-24: Type [`bool`][] :material-equal: `False`{ title="default value" }**
608602
<!-- - **:octicons-project-template-24: Template :material-null:** (N/A) -->
609603

docs/usage/configuration/members.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -269,7 +269,7 @@ class Main(Base):
269269

270270
The members ordering to use. Possible values:
271271

272-
- `__all__` ([:octicons-heart-fill-24:{ .pulse } Sponsors only](../../insiders/index.md){ .insiders } &mdash; [:octicons-tag-24: Insiders 1.12.0](../../insiders/changelog.md#1.12.0)): Order according to `__all__` attributes. Since classes do not define `__all__` attributes, you can specify a second ordering method by using a list.
272+
- `__all__`: Order according to `__all__` attributes. Since classes do not define `__all__` attributes, you can specify a second ordering method by using a list.
273273
- `alphabetical`: Order by the members names.
274274
- `source`: Order members as they appear in the source file.
275275

@@ -351,9 +351,6 @@ A list of filters, or `"public"`.
351351

352352
[](){#option-filters-public}
353353

354-
[:octicons-heart-fill-24:{ .pulse } Sponsors only](../../insiders/index.md){ .insiders } &mdash;
355-
[:octicons-tag-24: Insiders 1.11.0](../../insiders/changelog.md#1.11.0)
356-
357354
The `public` filtering method will include only public objects: those added to the `__all__` attribute of modules, or not starting with a single underscore. Special methods and attributes ("dunder" methods/attributes, starting and ending with two underscores), like `__init__`, `__call__`, `__mult__`, etc., are always considered public.
358355

359356
**List of filters**
@@ -577,8 +574,6 @@ package
577574
[](){#option-summary}
578575
## `summary`
579576

580-
[:octicons-tag-24: Insiders 1.2.0](../../insiders/changelog.md#1.2.0)
581-
582577
- **: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" }**
583578
<!-- - **:octicons-project-template-24: Template :material-null:** (N/A) -->
584579

docs/usage/configuration/signatures.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -203,12 +203,6 @@ plugins:
203203
[](){#option-modernize_annotations}
204204
## `modernize_annotations`
205205

206-
[:octicons-heart-fill-24:{ .pulse } Sponsors only](../../insiders/index.md){ .insiders } &mdash;
207-
[:octicons-tag-24: Insiders 1.8.0](../../insiders/changelog.md#1.8.0) &mdash;
208-
**This feature also requires
209-
[Griffe Insiders](https://mkdocstrings.github.io/griffe/insiders/)
210-
to be installed.**
211-
212206
- **:octicons-package-24: Type [`bool`][] :material-equal: `False`{ title="default value" }**
213207
<!-- - **:octicons-project-template-24: Template :material-null:** (contained in [`class.html`][class template]) -->
214208

@@ -637,8 +631,6 @@ Function docstring.
637631
[](){#option-signature_crossrefs}
638632
## `signature_crossrefs`
639633

640-
[:octicons-tag-24: Insiders 1.0.0](../../insiders/changelog.md#1.0.0)
641-
642634
Whether to render cross-references for type annotations in signatures.
643635

644636
When signatures are separated from headings with the [`separate_signature`][] option

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ plugins:
137137
- autorefs
138138
- markdown-exec
139139
- section-index
140-
# - coverage
140+
- coverage
141141
- mkdocstrings:
142142
handlers:
143143
python:

src/mkdocstrings_handlers/python/_internal/config.py

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -519,9 +519,6 @@ class PythonInputOptions:
519519
520520
**Filtering methods**
521521
522-
[:octicons-heart-fill-24:{ .pulse } Sponsors only](../insiders/index.md){ .insiders } &mdash;
523-
[:octicons-tag-24: Insiders 1.11.0](../insiders/changelog.md#1.11.0)
524-
525522
The `public` method will include only public objects:
526523
those added to `__all__` or not starting with an underscore (except for special methods/attributes).
527524
""",

0 commit comments

Comments
 (0)