mkdocstrings-python 1.13.0__tar.gz → 1.14.0__tar.gz

{mkdocstrings_python-1.13.0 → mkdocstrings_python-1.14.0}/CHANGELOG.md

@@ -5,6 +5,19 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 <!-- insertion marker -->
+## [1.14.0](https://github.com/mkdocstrings/python/releases/tag/1.14.0) - 2025-02-03
+
+<small>[Compare with 1.13.0](https://github.com/mkdocstrings/python/compare/1.13.0...1.14.0)</small>
+
+### Features
+
+- Add `heading` and `toc_label` options ([7cabacf](https://github.com/mkdocstrings/python/commit/7cabacf13735dbc5066793baf5820d61cd342dc8) by Yann Van Crombrugge). [Issue-mkdocstrings-725](https://github.com/mkdocstrings/mkdocstrings/issues/725), [PR-236](https://github.com/mkdocstrings/python/pull/236)
+- Add `force_inspection` option to force dynamic analysis ([83823be](https://github.com/mkdocstrings/python/commit/83823be2146d6a2ecedc5fe9c0cfd84098d780ca) by Uchechukwu Orji). [Issue-94](https://github.com/mkdocstrings/python/issues/94), [PR-231](https://github.com/mkdocstrings/python/pull/231)
+
+### Code Refactoring
+
+- Use dataclasses for configuration/options and automate schema generation ([5ebeda6](https://github.com/mkdocstrings/python/commit/5ebeda6fce1b1bc7cb3f5e27a5a90ac394a3de0c) by Timothée Mazzucotelli).
+
 ## [1.13.0](https://github.com/mkdocstrings/python/releases/tag/1.13.0) - 2024-12-26
 
 <small>[Compare with 1.12.2](https://github.com/mkdocstrings/python/compare/1.12.2...1.13.0)</small>
@@ -227,12 +240,12 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 - Release Insiders features of the $500/month funding goal ([bd30106](https://github.com/mkdocstrings/python/commit/bd301061fe9c647f9b91c2c9b4baa784c304eca7) by Timothée Mazzucotelli).
     The features and projects related to *mkdocstrings-python* are:
-    
+
     - [Cross-references for type annotations in signatures](https://mkdocstrings.github.io/python/usage/configuration/signatures/#signature_crossrefs)
     - [Symbol types in headings and table of contents](https://mkdocstrings.github.io/python/usage/configuration/headings/#show_symbol_type_toc)
     - [`griffe-inherited-docstrings`](https://mkdocstrings.github.io/griffe-inherited-docstrings/), a Griffe extension for inheriting docstrings
     - [`griffe2md`](https://mkdocstrings.github.io/griffe2md/), a tool to output API docs to Markdown using Griffe
-    
+
     See the complete list of features and projects here:
     https://pawamoy.github.io/insiders/#500-plasmavac-user-guide.
 
@@ -464,7 +477,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
     You can see how to use the filter in this commit's changes:
     [f686f4e4](https://github.com/mkdocstrings/python/commit/f686f4e4599cea64686d4ef4863b507dd096a513).
-    
+
 **We take this as an opportunity to go out of beta and bump the version to 1.0.0.
 This will allow users to rely on semantic versioning.**
 

{mkdocstrings_python-1.13.0 → mkdocstrings_python-1.14.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mkdocstrings-python
-Version: 1.13.0
+Version: 1.14.0
 Summary: A Python handler for mkdocstrings.
 Author-Email: =?utf-8?q?Timoth=C3=A9e_Mazzucotelli?= <dev@pawamoy.fr>
 License: ISC
@@ -29,9 +29,10 @@ Project-URL: Discussions, https://github.com/mkdocstrings/python/discussions
 Project-URL: Gitter, https://gitter.im/mkdocstrings/python
 Project-URL: Funding, https://github.com/sponsors/pawamoy
 Requires-Python: >=3.9
-Requires-Dist: mkdocstrings>=0.26
+Requires-Dist: mkdocstrings>=0.28
 Requires-Dist: mkdocs-autorefs>=1.2
 Requires-Dist: griffe>=0.49
+Requires-Dist: typing-extensions>=4.0; python_version < "3.11"
 Description-Content-Type: text/markdown
 
 <h1 align="center">mkdocstrings-python</h1>

{mkdocstrings_python-1.13.0 → mkdocstrings_python-1.14.0}/config/pytest.ini

@@ -10,8 +10,7 @@ testpaths =
 # action:message_regex:warning_class:module_regex:line
 filterwarnings =
   error
-  # TODO: remove once pytest-xdist 4 is released
+  # TODO: Remove once pytest-xdist 4 is released.
   ignore:.*rsyncdir:DeprecationWarning:xdist
-  # TODO: remove once Griffe releases v1
-  ignore:.*`get_logger`:DeprecationWarning:_griffe
-  ignore:.*`name`:DeprecationWarning:_griffe
+  # TODO: Remove once mkdocstrings stops setting fallback function.
+  ignore:.*fallback anchor function:DeprecationWarning:mkdocstrings

{mkdocstrings_python-1.13.0 → mkdocstrings_python-1.14.0}/docs/.glossary.md

@@ -6,7 +6,7 @@
 [Griffe]: https://github.com/mkdocstrings/griffe
 [ReadTheDocs Sphinx theme]: https://sphinx-rtd-theme.readthedocs.io/en/stable/index.html
 [Spacy's documentation]: https://spacy.io/api/doc/
-[Black]: https://pypi.org/project/black/ 
+[Black]: https://pypi.org/project/black/
 [Material for MkDocs]: https://squidfunk.github.io/mkdocs-material
 [Ruff]: https://docs.astral.sh/ruff
 

{mkdocstrings_python-1.13.0 → mkdocstrings_python-1.14.0}/docs/.overrides/main.html

@@ -1,13 +1,13 @@
 {% extends "base.html" %}
 
 {% block announce %}
-  
+
     <strong>Fund this project</strong> through
     <a href="{{ 'insiders/#how-to-become-a-sponsor' | url }}"><strong>sponsorship</strong></a>
     <span class="twemoji heart pulse">
       {% include ".icons/octicons/heart-fill-16.svg" %}
     </span> &mdash;
-  
+
   Follow
   <strong>@pawamoy</strong> on
   <a rel="me" href="https://fosstodon.org/@pawamoy">

{mkdocstrings_python-1.13.0 → mkdocstrings_python-1.14.0}/docs/.overrides/partials/comments.html

@@ -31,7 +31,7 @@
                 : "light"
 
             // Instruct Giscus to set theme
-            giscus.setAttribute("data-theme", theme) 
+            giscus.setAttribute("data-theme", theme)
         }
 
         // Register event handlers after documented loaded

{mkdocstrings_python-1.13.0 → mkdocstrings_python-1.14.0}/docs/insiders/index.md

@@ -161,7 +161,7 @@ You can cancel your sponsorship anytime.[^5]
 
 The following section lists all funding goals. Each goal contains a list of
 features prefixed with a checkmark symbol, denoting whether a feature is
-:octicons-check-circle-fill-24:{ style="color: #00e676" } already available or 
+:octicons-check-circle-fill-24:{ style="color: #00e676" } already available or
 :octicons-check-circle-fill-24:{ style="color: var(--md-default-fg-color--lightest)" } planned,
 but not yet implemented. When the funding goal is hit,
 the features are released for general availability.
@@ -221,7 +221,7 @@ by the [ISC License][license]. However, we kindly ask you to respect our
 
 - Please **don't distribute the source code** of Insiders. You may freely use
   it for public, private or commercial projects, privately fork or mirror it,
-  but please don't make the source code public, as it would counteract the 
+  but please don't make the source code public, as it would counteract the
   sponsorware strategy.
 
 - If you cancel your subscription, you're automatically removed as a

{mkdocstrings_python-1.13.0 → mkdocstrings_python-1.14.0}/docs/insiders/installation.md

@@ -42,21 +42,21 @@ Or using HTTPS:
 pip install git+https://${GH_TOKEN}@github.com/pawamoy-insiders/mkdocstrings-python.git
 ```
 
->? NOTE: **How to get a GitHub personal access token**  
+>? NOTE: **How to get a GitHub personal access token?**
 > The `GH_TOKEN` environment variable is a GitHub token.
 > It can be obtained by creating a [personal access token] for
 > your GitHub account. It will give you access to the Insiders repository,
 > programmatically, from the command line or GitHub Actions workflows:
-> 
+>
 > 1.  Go to https://github.com/settings/tokens
 > 2.  Click on [Generate a new token]
 > 3.  Enter a name and select the [`repo`][scopes] scope
 > 4.  Generate the token and store it in a safe place
-> 
+>
 >   [personal access token]: https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token
 >   [Generate a new token]: https://github.com/settings/tokens/new
 >   [scopes]: https://docs.github.com/en/developers/apps/scopes-for-oauth-apps#available-scopes
-> 
+>
 > Note that the personal access
 > token must be kept secret at all times, as it allows the owner to access your
 > private repositories.

{mkdocstrings_python-1.13.0 → mkdocstrings_python-1.14.0}/docs/usage/configuration/docstrings.md

@@ -1,5 +1,6 @@
 # Docstrings options
 
+[](){#option-docstring_style}
 ## `docstring_style`
 
 - **:octicons-package-24: Type [`str`][] :material-equal: `"google"`{ title="default value" }**
@@ -29,6 +30,9 @@ plugins:
       docstring_style: numpy
 ```
 
+WARNING: **The style is applied to the specified object only, not its members.** Local `docstring_style` options (in `:::` instructions) will only be applied to the specified object, and not its members. Instead of changing the style when rendering, we strongly recommend to *set the right style as early as possible*, for example by using the [auto-style](https://mkdocstrings.github.io/griffe/reference/docstrings/#auto-style) (sponsors only), or with a custom Griffe extension
+
+
 /// admonition | Preview
     type: preview
 
@@ -81,6 +85,7 @@ def greet(name: str) -> str:
 ////
 ///
 
+[](){#option-docstring_options}
 ## `docstring_options`
 
 - **:octicons-package-24: Type [`dict`][] :material-equal: `{}`{ title="default value" }**
@@ -155,6 +160,7 @@ ok
 ////
 ///
 
+[](){#option-docstring_section_style}
 ## `docstring_section_style`
 
 - **:octicons-package-24: Type [`str`][] :material-equal: `"table"`{ title="default value" }**
@@ -246,6 +252,7 @@ by reserving more horizontal space on the second column.
 ////
 ///
 
+[](){#option-merge_init_into_class}
 ## `merge_init_into_class`
 
 - **:octicons-package-24: Type [`bool`][] :material-equal: `False`{ title="default value" }**
@@ -317,6 +324,7 @@ class Thing:
 ////
 ///
 
+[](){#option-relative_crossrefs}
 ## `relative_crossrefs`
 
 [:octicons-heart-fill-24:{ .pulse } Sponsors only](../../insiders/index.md){ .insiders } —
@@ -429,6 +437,7 @@ class Class:
 
 INFO: **There is an alternative, third-party Python handler that handles relative references: [mkdocstrings-python-xref](https://github.com/analog-garage/mkdocstrings-python-xref).**
 
+[](){#option-scoped_crossrefs}
 ## `scoped_crossrefs`
 
 [:octicons-heart-fill-24:{ .pulse } Sponsors only](../../insiders/index.md){ .insiders } —
@@ -449,7 +458,7 @@ The following order is applied when resolving a name in a given scope:
 
 In practice, it means that the name is first looked up in members, then it is compared against the parent name (only if it's a class), then it is looked up in siblings. It continues climbing up the object tree until there's no parent, in which case it raises a name resolution error.
 
-Cross-referencing an imported object will directly link to this object if the objects inventory of the project it comes from was [loaded][import]. You won't be able to cross-reference it within your own documentation with scoped references, if you happen to be rendering this external object too. In that case, you can use an absolute reference or a [relative][relative_crossrefs] one instead.
+Cross-referencing an imported object will directly link to this object if the objects inventory of the project it comes from was [loaded][inventories]. You won't be able to cross-reference it within your own documentation with scoped references, if you happen to be rendering this external object too. In that case, you can use an absolute reference or a [relative][relative_crossrefs] one instead.
 
 Another limitation is that you won't be able to reference an external package if its name can be resolved in the current object's scope.
 
@@ -538,6 +547,7 @@ class Class:
 
 ///
 
+[](){#option-show_if_no_docstring}
 ## `show_if_no_docstring`
 
 - **:octicons-package-24: Type [`bool`][] :material-equal: `False`{ title="default value" }**
@@ -607,6 +617,7 @@ class ClassWithoutDocstring:
 ////
 ///
 
+[](){#option-show_docstring_attributes}
 ## `show_docstring_attributes`
 
 - **:octicons-package-24: Type [`bool`][] :material-equal: `True`{ title="default value" }**
@@ -659,6 +670,7 @@ class Class:
 ////
 ///
 
+[](){#option-show_docstring_functions}
 ## `show_docstring_functions`
 
 - **:octicons-package-24: Type [`bool`][] :material-equal: `True`{ title="default value" }**
@@ -733,7 +745,7 @@ class Class:
 ////
 ///
 
-
+[](){#option-show_docstring_classes}
 ## `show_docstring_classes`
 
 - **:octicons-package-24: Type [`bool`][] :material-equal: `True`{ title="default value" }**
@@ -792,6 +804,7 @@ class Class:
 ////
 ///
 
+[](){#option-show_docstring_modules}
 ## `show_docstring_modules`
 
 - **:octicons-package-24: Type [`bool`][] :material-equal: `True`{ title="default value" }**
@@ -848,6 +861,7 @@ Modules:
 ////
 ///
 
+[](){#option-show_docstring_description}
 ## `show_docstring_description`
 
 - **:octicons-package-24: Type [`bool`][] :material-equal: `True`{ title="default value" }**
@@ -911,6 +925,7 @@ class Class:
 ////
 ///
 
+[](){#option-show_docstring_examples}
 ## `show_docstring_examples`
 
 - **:octicons-package-24: Type [`bool`][] :material-equal: `True`{ title="default value" }**
@@ -964,6 +979,7 @@ hello
 ////
 ///
 
+[](){#option-show_docstring_other_parameters}
 ## `show_docstring_other_parameters`
 
 - **:octicons-package-24: Type [`bool`][] :material-equal: `True`{ title="default value" }**
@@ -1014,6 +1030,7 @@ def do_something(**kwargs):
 ////
 ///
 
+[](){#option-show_docstring_parameters}
 ## `show_docstring_parameters`
 
 - **:octicons-package-24: Type [`bool`][] :material-equal: `True`{ title="default value" }**
@@ -1064,6 +1081,7 @@ def do_something(whatever: int = 0):
 ////
 ///
 
+[](){#option-show_docstring_raises}
 ## `show_docstring_raises`
 
 - **:octicons-package-24: Type [`bool`][] :material-equal: `True`{ title="default value" }**
@@ -1115,6 +1133,7 @@ def raise_runtime_error():
 ////
 ///
 
+[](){#option-show_docstring_receives}
 ## `show_docstring_receives`
 
 - **:octicons-package-24: Type [`bool`][] :material-equal: `True`{ title="default value" }**
@@ -1174,6 +1193,7 @@ def iter_skip(
 ////
 ///
 
+[](){#option-show_docstring_returns}
 ## `show_docstring_returns`
 
 - **:octicons-package-24: Type [`bool`][] :material-equal: `True`{ title="default value" }**
@@ -1225,6 +1245,7 @@ def rand() -> int:
 ////
 ///
 
+[](){#option-show_docstring_warns}
 ## `show_docstring_warns`
 
 - **:octicons-package-24: Type [`bool`][] :material-equal: `True`{ title="default value" }**
@@ -1276,6 +1297,7 @@ def warn():
 ////
 ///
 
+[](){#option-show_docstring_yields}
 ## `show_docstring_yields`
 
 - **:octicons-package-24: Type [`bool`][] :material-equal: `True`{ title="default value" }**