mkdocstrings-python 1.16.5__tar.gz → 1.16.6__tar.gz

{mkdocstrings_python-1.16.5 → mkdocstrings_python-1.16.6}/CHANGELOG.md

@@ -5,6 +5,23 @@ 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.16.6](https://github.com/mkdocstrings/python/releases/tag/1.16.6) - 2025-03-18
+
+<small>[Compare with 1.16.5](https://github.com/mkdocstrings/python/compare/1.16.5...1.16.6)</small>
+
+### Deprecations
+
+Importing from submodules is now deprecated: the public API is fully exposed under the top-level `mkdocstrings_handler.python` module.
+
+### Bug Fixes
+
+- Add back default compiled filters (regression) ([2d83900](https://github.com/mkdocstrings/python/commit/2d83900c9e258399c90ecbac350ad03ff5d8f311) by Timothée Mazzucotelli). [Issue-264](https://github.com/mkdocstrings/python/issues/264)
+
+### Code Refactoring
+
+- Start logging warnings instead of info messages about deprecated use of templates ([7606f33](https://github.com/mkdocstrings/python/commit/7606f33559ced6962ecf9a1bc9aa76f24d87f515) by Timothée Mazzucotelli).
+- Move modules into internal folder, expose API in top-level module ([93a68d0](https://github.com/mkdocstrings/python/commit/93a68d0d7afce38c78a8264189cfa812d737666c) by Timothée Mazzucotelli).
+
 ## [1.16.5](https://github.com/mkdocstrings/python/releases/tag/1.16.5) - 2025-03-10
 
 <small>[Compare with 1.16.4](https://github.com/mkdocstrings/python/compare/1.16.4...1.16.5)</small>
@@ -589,7 +606,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ### Breaking changes
 
-- The signature of the [`format_signature` filter](https://mkdocstrings.github.io/python/reference/mkdocstrings_handlers/python/rendering/#mkdocstrings_handlers.python.rendering.do_format_signature) has changed.
+- The signature of the [`format_signature` filter][mkdocstrings_handlers.python.do_format_signature] has changed.
     If you override templates in your project to customize the output,
     make sure to update the following templates so that they use
     the new filter signature:

mkdocstrings_python-1.16.6/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at dev@pawamoy.fr. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at [https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations
+

{mkdocstrings_python-1.16.5 → mkdocstrings_python-1.16.6}/CONTRIBUTING.md

@@ -1,7 +1,6 @@
 # Contributing
 
-Contributions are welcome, and they are greatly appreciated!
-Every little bit helps, and credit will always be given.
+Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
 
 ## Environment setup
 
@@ -14,11 +13,7 @@ cd python
 make setup
 ```
 
-> NOTE:
-> If it fails for some reason,
-> you'll need to install
-> [uv](https://github.com/astral-sh/uv)
-> manually.
+> NOTE: If it fails for some reason, you'll need to install [uv](https://github.com/astral-sh/uv) manually.
 >
 > You can install it with:
 >
@@ -26,8 +21,7 @@ make setup
 > curl -LsSf https://astral.sh/uv/install.sh | sh
 > ```
 >
-> Now you can try running `make setup` again,
-> or simply `uv sync`.
+> Now you can try running `make setup` again, or simply `uv sync`.
 
 You now have the dependencies installed.
 
@@ -35,15 +29,10 @@ Run `make help` to see all the available actions!
 
 ## Tasks
 
-The entry-point to run commands and tasks is the `make` Python script,
-located in the `scripts` directory. Try running `make` to show the available commands and tasks.
-The *commands* do not need the Python dependencies to be installed,
-while the *tasks* do.
-The cross-platform tasks are written in Python, thanks to [duty](https://github.com/pawamoy/duty).
+The entry-point to run commands and tasks is the `make` Python script, located in the `scripts` directory. Try running `make` to show the available commands and tasks. The *commands* do not need the Python dependencies to be installed,
+while the *tasks* do. The cross-platform tasks are written in Python, thanks to [duty](https://github.com/pawamoy/duty).
 
-If you work in VSCode, we provide
-[an action to configure VSCode](https://pawamoy.github.io/copier-uv/work/#vscode-setup)
-for the project.
+If you work in VSCode, we provide [an action to configure VSCode](https://pawamoy.github.io/copier-uv/work/#vscode-setup) for the project.
 
 ## Development
 
@@ -62,17 +51,13 @@ As usual:
     1. go to http://localhost:8000 and check that everything looks good
 1. follow our [commit message convention](#commit-message-convention)
 
-If you are unsure about how to fix or ignore a warning,
-just let the continuous integration fail,
-and we will help you during review.
+If you are unsure about how to fix or ignore a warning, just let the continuous integration fail, and we will help you during review.
 
 Don't bother updating the changelog, we will take care of this.
 
 ## Commit message convention
 
-Commit messages must follow our convention based on the
-[Angular style](https://gist.github.com/stephenparish/9941e89d80e2bc58a153#format-of-the-commit-message)
-or the [Karma convention](https://karma-runner.github.io/4.0/dev/git-commit-msg.html):
+Commit messages must follow our convention based on the [Angular style](https://gist.github.com/stephenparish/9941e89d80e2bc58a153#format-of-the-commit-message) or the [Karma convention](https://karma-runner.github.io/4.0/dev/git-commit-msg.html):
 
 ```
 <type>[(scope)]: Subject
@@ -80,10 +65,7 @@ or the [Karma convention](https://karma-runner.github.io/4.0/dev/git-commit-msg.
 [Body]
 ```
 
-**Subject and body must be valid Markdown.**
-Subject must have proper casing (uppercase for first letter
-if it makes sense), but no dot at the end, and no punctuation
-in general.
+**Subject and body must be valid Markdown.** Subject must have proper casing (uppercase for first letter if it makes sense), but no dot at the end, and no punctuation in general.
 
 Scope and body are optional. Type can be:
 
@@ -99,9 +81,7 @@ Scope and body are optional. Type can be:
 - `style`: A change in code style/format.
 - `tests`: About tests.
 
-If you write a body, please add trailers at the end
-(for example issues and PR references, or co-authors),
-without relying on GitHub's flavored Markdown:
+If you write a body, please add trailers at the end (for example issues and PR references, or co-authors), without relying on GitHub's flavored Markdown:
 
 ```
 Body.
@@ -110,16 +90,9 @@ Issue #10: https://github.com/namespace/project/issues/10
 Related to PR namespace/other-project#15: https://github.com/namespace/other-project/pull/15
 ```
 
-These "trailers" must appear at the end of the body,
-without any blank lines between them. The trailer title
-can contain any character except colons `:`.
-We expect a full URI for each trailer, not just GitHub autolinks
-(for example, full GitHub URLs for commits and issues,
-not the hash or the #issue-number).
+These "trailers" must appear at the end of the body, without any blank lines between them. The trailer title can contain any character except colons `:`. We expect a full URI for each trailer, not just GitHub autolinks (for example, full GitHub URLs for commits and issues, not the hash or the #issue-number).
 
-We do not enforce a line length on commit messages summary and body,
-but please avoid very long summaries, and very long lines in the body,
-unless they are part of code blocks that must not be wrapped.
+We do not enforce a line length on commit messages summary and body, but please avoid very long summaries, and very long lines in the body, unless they are part of code blocks that must not be wrapped.
 
 ## Pull requests guidelines
 
@@ -144,5 +117,4 @@ And force-push:
 git push -f
 ```
 
-If this seems all too complicated, you can push or force-push each new commit,
-and we will squash them ourselves if needed, before merging.
+If this seems all too complicated, you can push or force-push each new commit, and we will squash them ourselves if needed, before merging.

{mkdocstrings_python-1.16.5 → mkdocstrings_python-1.16.6}/PKG-INFO

@@ -1,9 +1,10 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: mkdocstrings-python
-Version: 1.16.5
+Version: 1.16.6
 Summary: A Python handler for mkdocstrings.
 Author-Email: =?utf-8?q?Timoth=C3=A9e_Mazzucotelli?= <dev@pawamoy.fr>
-License: ISC
+License-Expression: ISC
+License-File: LICENSE
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
 Classifier: Programming Language :: Python

{mkdocstrings_python-1.16.5 → mkdocstrings_python-1.16.6}/config/ruff.toml

@@ -47,17 +47,24 @@ ignore = [
 ]
 
 [lint.per-file-ignores]
-"src/*/cli.py" = [
+"src/**/cli.py" = [
     "T201",  # Print statement
 ]
 "src/*/debug.py" = [
     "T201",  # Print statement
 ]
+"!src/*/*.py" = [
+    "D100",  # Missing docstring in public module
+]
+"!src/**.py" = [
+    "D101",  # Missing docstring in public class
+    "D103",  # Missing docstring in public function
+]
 "scripts/*.py" = [
     "INP001",  # File is part of an implicit namespace package
     "T201",  # Print statement
 ]
-"tests/*.py" = [
+"tests/**.py" = [
     "ARG005",  # Unused lambda argument
     "FBT001",  # Boolean positional arg in function definition
     "PLR2004",  # Magic value used in comparison

{mkdocstrings_python-1.16.5 → mkdocstrings_python-1.16.6}/config/vscode/launch.json

@@ -7,7 +7,17 @@
             "request": "launch",
             "program": "${file}",
             "console": "integratedTerminal",
-            "justMyCode": false
+            "justMyCode": false,
+            "args": "${command:pickArgs}"
+        },
+        {
+            "name": "run",
+            "type": "debugpy",
+            "request": "launch",
+            "module": "python",
+            "console": "integratedTerminal",
+            "justMyCode": false,
+            "args": "${command:pickArgs}"
         },
         {
             "name": "docs",

mkdocstrings_python-1.16.6/docs/.overrides/partials/path-item.html

@@ -0,0 +1,22 @@
+{# Fix breadcrumbs for when mkdocs-section-index is used. #}
+{# See https://github.com/squidfunk/mkdocs-material/issues/7614. #}
+
+<!-- Render navigation link content -->
+{% macro render_content(nav_item) %}
+  <span class="md-ellipsis">
+    {{ nav_item.title }}
+  </span>
+{% endmacro %}
+
+<!-- Render navigation item -->
+{% macro render(nav_item, ref=nav_item) %}
+  {% if nav_item.is_page %}
+    <li class="md-path__item">
+      <a href="{{ nav_item.url | url }}" class="md-path__link">
+        {{ render_content(ref) }}
+      </a>
+    </li>
+  {% elif nav_item.children %}
+    {{ render(nav_item.children | first, ref) }}
+  {% endif %}
+{% endmacro %}

mkdocstrings_python-1.16.6/docs/changelog.md

@@ -0,0 +1,5 @@
+---
+title: Changelog
+---
+
+--8<-- "CHANGELOG.md"

mkdocstrings_python-1.16.6/docs/code_of_conduct.md

@@ -0,0 +1,5 @@
+---
+title: Code of Conduct
+---
+
+--8<-- "CODE_OF_CONDUCT.md"

mkdocstrings_python-1.16.6/docs/contributing.md

@@ -0,0 +1,5 @@
+---
+title: Contributing
+---
+
+--8<-- "CONTRIBUTING.md"

{mkdocstrings_python-1.16.5 → mkdocstrings_python-1.16.6}/docs/credits.md

@@ -1,10 +1,9 @@
 ---
+title: Credits
 hide:
 - toc
 ---
 
-<!-- blacken-docs:off -->
 ```python exec="yes"
 --8<-- "scripts/gen_credits.py"
 ```
-<!-- blacken-docs:on -->

{mkdocstrings_python-1.16.5 → mkdocstrings_python-1.16.6}/docs/index.md

@@ -1,4 +1,5 @@
 ---
+title: Overview
 hide:
 - feedback
 ---

{mkdocstrings_python-1.16.5 → mkdocstrings_python-1.16.6}/docs/insiders/changelog.md

@@ -81,6 +81,6 @@
 
 - Add [cross-references for type annotations in signatures](../usage/configuration/signatures.md#signature_crossrefs).
     Make sure to update your local templates as the signature of the
-    [`format_signature` filter][mkdocstrings_handlers.python.rendering.do_format_signature]
+    [`format_signature` filter][mkdocstrings_handlers.python.do_format_signature]
     has changed. The templates that must be updated:
     `class.html`, `expression.html`, `function.html` and `signature.html`.

mkdocstrings_python-1.16.6/docs/insiders/index.md

@@ -0,0 +1,161 @@
+---
+title: Insiders
+---
+
+# Insiders
+
+*mkdocstrings-python* follows the **sponsorware** release strategy, which means that new features are first exclusively released to sponsors as part of [Insiders][]. Read on to learn [what sponsorships achieve][sponsorship], [how to become a sponsor][sponsors] to get access to Insiders, and [what's in it for you][features]!
+
+## What is Insiders?
+
+*mkdocstrings-python Insiders* is a private fork of *mkdocstrings-python*, hosted as a private GitHub repository. Almost[^1] [all new features][features] are developed as part of this fork, which means that they are immediately available to all eligible sponsors, as they are granted access to this private repository.
+
+[^1]: In general, every new feature is first exclusively released to sponsors, but sometimes upstream dependencies enhance existing features that must be supported by *mkdocstrings-python*.
+
+Every feature is tied to a [funding goal][funding] in monthly subscriptions. When a funding goal is hit, the features that are tied to it are merged back into *mkdocstrings-python* and released for general availability, making them available to all users. Bugfixes are always released in tandem.
+
+Sponsorships start as low as [**$10 a month**][sponsors].[^2]
+
+[^2]: Note that $10 a month is the minimum amount to become eligible for Insiders. While GitHub Sponsors also allows to sponsor lower amounts or one-time amounts, those can't be granted access to Insiders due to technical reasons. Such contributions are still very much welcome as they help ensuring the project's sustainability.
+
+## What sponsorships achieve
+
+Sponsorships make this project sustainable, as they buy the maintainers of this project time – a very scarce resource – which is spent on the development of new features, bug fixing, stability improvement, issue triage and general support. The biggest bottleneck in Open Source is time.[^3]
+
+[^3]: Making an Open Source project sustainable is exceptionally hard: maintainers burn out, projects are abandoned. That's not great and very unpredictable. The sponsorware model ensures that if you decide to use *mkdocstrings-python*, you can be sure that bugs are fixed quickly and new features are added regularly.
+
+If you're unsure if you should sponsor this project, check out the list of [completed funding goals][goals completed] to learn whether you're already using features that were developed with the help of sponsorships. You're most likely using at least a handful of them, [thanks to our awesome sponsors][sponsors]!
+
+## What's in it for me?
+
+```python exec="1" session="insiders"
+data_source = [
+    "docs/insiders/goals.yml",
+    ("griffe-inherited-docstrings", "https://mkdocstrings.github.io/griffe-inherited-docstrings/", "insiders/goals.yml"),
+    ("griffe-pydantic", "https://mkdocstrings.github.io/griffe-pydantic/", "insiders/goals.yml"),
+    ("griffe-warnings-deprecated", "https://mkdocstrings.github.io/griffe-warnings-deprecated/", "insiders/goals.yml"),
+]
+```
+
+<!-- blacken-docs:off -->
+```python exec="1" session="insiders" idprefix=""
+--8<-- "scripts/insiders.py"
+
+if unreleased_features:
+    print(
+        "The moment you [become a sponsor](#how-to-become-a-sponsor), you'll get **immediate "
+        f"access to {len(unreleased_features)} additional features** that you can start using right away, and "
+        "which are currently exclusively available to sponsors:\n"
+    )
+
+    for feature in unreleased_features:
+        feature.render(badge=True)
+
+    print(
+        "\n\nThese are just the features related to this project. "
+        "[See the complete feature list on the author's main Insiders page](https://pawamoy.github.io/insiders/#whats-in-it-for-me)."
+    )
+else:
+    print(
+        "The moment you [become a sponsor](#how-to-become-a-sponsor), you'll get immediate "
+        "access to all released features that you can start using right away, and "
+        "which are exclusively available to sponsors. At this moment, there are no "
+        "Insiders features for this project, but checkout the [next funding goals](#goals) "
+        "to see what's coming, as well as **[the feature list for all Insiders projects](https://pawamoy.github.io/insiders/#whats-in-it-for-me).**"
+    )
+```
+<!-- blacken-docs:on -->
+
+Additionally, your sponsorship will give more weight to your upvotes on issues, helping us prioritize work items in our backlog. For more information on how we prioritize work, see this page: [Backlog management][backlog].
+
+## How to become a sponsor
+
+Thanks for your interest in sponsoring! In order to become an eligible sponsor with your GitHub account, visit [pawamoy's sponsor profile][github sponsor profile], and complete a sponsorship of **$10 a month or more**. You can use your individual or organization GitHub account for sponsoring.
+
+Sponsorships lower than $10 a month are also very much appreciated, and useful. They won't grant you access to Insiders, but they will be counted towards reaching sponsorship goals. Every sponsorship helps us implementing new features and releasing them to the public.
+
+**Important:** By default, when you're sponsoring **[@pawamoy][github sponsor profile]** through a GitHub organization, all the publicly visible members of the organization will be invited to join our private repositories. If you wish to only grant access to a subset of users, please send a short email to insiders@pawamoy.fr with the name of your organization and the GitHub accounts of the users that should be granted access.
+
+**Tip:** to ensure that access is not tied to a particular individual GitHub account, you can create a bot account (i.e. a GitHub account that is not tied to a specific individual), and use this account for the sponsoring. After being granted access to our private repositories, the bot account can create private forks of our private repositories into your own organization, which all members of your organization will have access to.
+
+You can cancel your sponsorship anytime.[^5]
+
+[^5]: If you cancel your sponsorship, GitHub schedules a cancellation request which will become effective at the end of the billing cycle. This means that even though you cancel your sponsorship, you will keep your access to Insiders as long as your cancellation isn't effective. All charges are processed by GitHub through Stripe. As we don't receive any information regarding your payment, and GitHub doesn't offer refunds, sponsorships are non-refundable.
+
+[:octicons-heart-fill-24:{ .pulse } &nbsp; Join our <span id="sponsors-count"></span> awesome sponsors][github sponsor profile]{ .md-button .md-button--primary }
+
+<hr>
+<div class="premium-sponsors">
+  <div id="gold-sponsors"></div>
+  <div id="silver-sponsors"></div>
+  <div id="bronze-sponsors"></div>
+</div>
+<hr>
+
+<div id="sponsors"></div>
+
+<small>
+  If you sponsor publicly, you're automatically added here with a link to your profile and avatar to show your support for *mkdocstrings-python*. Alternatively, if you wish to keep your sponsorship private, you'll be a silent +1. You can select visibility during checkout and change it afterwards.
+</small>
+
+## Funding <span class="sponsors-total"></span>
+
+### Goals
+
+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: var(--md-default-fg-color--lightest)" } planned, but not yet implemented. When the funding goal is hit, the features are released for general availability.
+
+```python exec="1" session="insiders" idprefix=""
+for goal in goals.values():
+    if not goal.complete:
+        goal.render()
+```
+
+### Goals completed
+
+This section lists all funding goals that were previously completed, which means that those features were part of Insiders, but are now generally available and can be used by all users.
+
+```python exec="1" session="insiders" idprefix=""
+for goal in goals.values():
+    if goal.complete:
+        goal.render()
+```
+
+## Frequently asked questions
+
+### Compatibility
+
+> We're building an open source project and want to allow outside collaborators to use *mkdocstrings-python* locally without having access to Insiders. Is this still possible?
+
+Yes. Insiders is compatible with *mkdocstrings-python*. Almost all new features and configuration options are either backward-compatible or implemented behind feature flags. Most Insiders features enhance the overall experience, though while these features add value for the users of your project, they shouldn't be necessary for previewing when making changes to content.
+
+### Payment
+
+> We don't want to pay for sponsorship every month. Are there any other options?
+
+Yes. You can sponsor on a yearly basis by [switching your GitHub account to a yearly billing cycle][billing cycle]. If for some reason you cannot do that, you could also create a dedicated GitHub account with a yearly billing cycle, which you only use for sponsoring (some sponsors already do that).
+
+If you have any problems or further questions, please reach out to insiders@pawamoy.fr.
+
+### Terms
+
+> Are we allowed to use Insiders under the same terms and conditions as *mkdocstrings-python*?
+
+Yes. Whether you're an individual or a company, you may use *mkdocstrings-python Insiders* precisely under the same terms as *mkdocstrings-python*, which are given by the [ISC license][license]. However, we kindly ask you to respect our **fair use policy**:
+
+- 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 sponsorware strategy.
+- If you cancel your subscription, your access to the private repository is revoked, and you will miss out on all future updates of Insiders. However, you may **use the latest version** that's available to you **as long as you like**. Just remember that [GitHub deletes private forks][private forks].
+
+[backlog]: https://pawamoy.github.io/backlog/
+[insiders]: #what-is-insiders
+[sponsorship]: #what-sponsorships-achieve
+[sponsors]: #how-to-become-a-sponsor
+[features]: #whats-in-it-for-me
+[funding]: #funding
+[goals completed]: #goals-completed
+[github sponsor profile]: https://github.com/sponsors/pawamoy
+[billing cycle]: https://docs.github.com/en/github/setting-up-and-managing-billing-and-payments-on-github/changing-the-duration-of-your-billing-cycle
+[license]: ../license.md
+[private forks]: https://docs.github.com/en/github/setting-up-and-managing-your-github-user-account/removing-a-collaborator-from-a-personal-repository
+
+<script src="../js/insiders.js"></script>
+<script>updateInsidersPage('pawamoy');</script>

mkdocstrings_python-1.16.6/docs/insiders/installation.md

@@ -0,0 +1,67 @@
+---
+title: Getting started with Insiders
+---
+
+# Getting started with Insiders
+
+*mkdocstrings-python Insiders* is a compatible drop-in replacement for *mkdocstrings-python*, and can be installed similarly using `pip` or `git`. Note that in order to access the Insiders repository, you need to [become an eligible sponsor][] of @pawamoy on GitHub.
+
+## Installation
+
+### with the `insiders` tool
+
+[`insiders`][insiders-tool] is a tool that helps you keep up-to-date versions of Insiders projects in the PyPI index of your choice (self-hosted, Google registry, Artifactory, etc.).
+
+**We kindly ask that you do not upload the distributions to public registries, as it is against our [Terms of use][].**
+
+### with pip (ssh/https)
+
+*mkdocstrings-python Insiders* can be installed with `pip` [using SSH][install-pip-ssh]:
+
+```bash
+pip install git+ssh://git@github.com/pawamoy-insiders/mkdocstrings-python.git
+```
+
+Or using HTTPS:
+
+```bash
+pip install git+https://${GH_TOKEN}@github.com/pawamoy-insiders/mkdocstrings-python.git
+```
+
+>? 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][github-pat] 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][github-pat-new]
+> 3.  Enter a name and select the [`repo`][scopes] scope
+> 4.  Generate the token and store it in a safe place
+>
+> Note that the personal access token must be kept secret at all times, as it allows the owner to access your private repositories.
+
+### with Git
+
+Of course, you can use *mkdocstrings-python Insiders* directly using Git:
+
+```
+git clone git@github.com:pawamoy-insiders/mkdocstrings-python
+```
+
+When cloning with Git, the package must be installed:
+
+```
+pip install -e mkdocstrings-python
+```
+
+## Upgrading
+
+When upgrading Insiders, you should always check the version of *mkdocstrings-python* which makes up the first part of the version qualifier. For example, a version like `8.x.x.4.x.x` means that Insiders `4.x.x` is currently based on `8.x.x`.
+
+If the major version increased, it's a good idea to consult the [changelog][] and go through the steps to ensure your configuration is up to date and all necessary changes have been made.
+
+[become an eligible sponsor]: ./index.md#how-to-become-a-sponsor
+[changelog]: ./changelog.md
+[github-pat]: https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token
+[github-pat-new]: https://github.com/settings/tokens/new
+[insiders-tool]: https://pawamoy.github.io/insiders-project/
+[install-pip-ssh]: https://docs.github.com/en/authentication/connecting-to-github-with-ssh
+[scopes]: https://docs.github.com/en/developers/apps/scopes-for-oauth-apps#available-scopes
+[terms of use]: ./index.md#terms

{mkdocstrings_python-1.16.5 → mkdocstrings_python-1.16.6}/docs/license.md

@@ -1,4 +1,5 @@
 ---
+title: License
 hide:
 - feedback
 ---

mkdocstrings_python-1.16.6/docs/reference/api.md

@@ -0,0 +1,9 @@
+---
+title: API reference
+hide:
+- navigation
+---
+
+# ::: mkdocstrings_handlers.python
+    options:
+        show_submodules: true

{mkdocstrings_python-1.16.5 → mkdocstrings_python-1.16.6}/docs/usage/configuration/general.md

@@ -90,7 +90,17 @@ plugins:
           backlinks: tree
 ```
 
-<!-- TODO: Add screenshots! -->
+/// admonition | Preview
+    type: preview
+
+//// tab | Flat
+![backlinks-flat](https://github.com/user-attachments/assets/f7a15b01-f194-4c55-8281-50adbb4a74af)
+////
+
+//// tab | Tree
+![backlinks-tree](https://github.com/user-attachments/assets/3457db21-45e1-4e03-bd8c-2e9e75dc778b)
+////
+///
 
 [](){#option-extensions}
 ## `extensions`