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, how to become a sponsor to get access to Insiders, and what's in it for you!
What is Insiders?¤
mkdocstrings-python Insiders is a private fork of mkdocstrings-python, hosted as a private GitHub repository. Almost1 all new features are developed as part of this fork, which means that they are immediately available to all eligible sponsors, as they are made collaborators of this repository.
Every feature is tied to a funding goal 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.2
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
If you're unsure if you should sponsor this project, check out the list of completed funding goals to learn whether you're already using features that were developed with the help of sponsorships.
What's in it for me?¤
The moment you become a sponsor, you'll get immediate access to 6 additional features that you can start using right away, and which are currently exclusively available to sponsors:
- Automatic rendering of function signature overloads
- Auto-summary of object members
- griffe-typing-deprecated — [Project] Griffe extension for
@typing.deprecated
(PEP 702) - griffe-pydantic — [Project] Griffe extension for Pydantic
- Symbol types in headings and table of contents
- Cross-references for type annotations in signatures
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, and complete a sponsorship of $10 a month or more. You can use your individual or organization GitHub account for sponsoring.
Important: If you're sponsoring @pawamoy through a GitHub organization, please send a short email to pawamoy@pm.me with the name of your organization and the GitHub account of the individual that should be added as a collaborator.4
You can cancel your sponsorship anytime.5
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.
Funding ¤
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 already available or planned, but not yet implemented. When the funding goal is hit, the features are released for general availability.
$ 500 — PlasmaVac User Guide¤
$ 1,000 — GraviFridge User Manual¤
- Auto-summary of object members
- Automatic rendering of function signature overloads
- griffe-pydantic — [Project] Griffe extension for Pydantic
- griffe-typing-deprecated — [Project] Griffe extension for
@typing.deprecated
(PEP 702)
What's in it for me?¤
The moment you become a sponsor, you'll get immediate access to 7 additional features that you can start using right away, and which are currently exclusively available to sponsors:
- griffe-inherited-docstrings — [Project] Griffe extension for inheriting docstrings
- Automatic rendering of function signature overloads
- Auto-summary of object members
- griffe-typing-deprecated — [Project] Griffe extension for
@typing.deprecated
(PEP 702) - griffe-pydantic — [Project] Griffe extension for Pydantic
- Symbol types in headings and table of contents
- Cross-references for type annotations in signatures
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, and complete a sponsorship of $10 a month or more. You can use your individual or organization GitHub account for sponsoring.
Important: If you're sponsoring @pawamoy through a GitHub organization, please send a short email to pawamoy@pm.me with the name of your organization and the GitHub account of the individual that should be added as a collaborator.4
You can cancel your sponsorship anytime.5
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.
Funding ¤
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 already available or planned, but not yet implemented. When the funding goal is hit, the features are released for general availability.
$ 500 — PlasmaVac User Guide¤
- Cross-references for type annotations in signatures
- Symbol types in headings and table of contents
- griffe-inherited-docstrings — [Project] Griffe extension for inheriting docstrings
$ 1,000 — GraviFridge User Manual¤
- Auto-summary of object members
- Automatic rendering of function signature overloads
- griffe-pydantic — [Project] Griffe extension for Pydantic
- griffe-typing-deprecated — [Project] Griffe extension for
@typing.deprecated
(PEP 702)