search

mkdocstrings / typescript

A TypeScript handler for mkdocstrings. Available to sponsors only.
https://mkdocstrings.github.io/typescript
ISC License
1 stars 0 forks source link

feat: Create a public version of the handler that is a no-op #1

Closed pawamoy closed 4 months ago

pawamoy commented 4 months ago

As mentioned by @sydney-runkle in a conversation we had, private handlers cannot be listed as dependency in open-source projects because contributors who do not have access cannot even install them. Therefore we should at least provide a public version on PyPI that does nothing. This way sponsors can list it in their dependencies (and override it with the insiders version in CI), and their contributors will be able to install docs dependencies and build the docs, even though the handler won't generate anything in the reference pages.

pawamoy commented 4 months ago

Released v0.0.1 on PyPI. Insiders version based on it coming up right now.

pawamoy commented 4 months ago

The public version will render messages like the following:

noop