Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

documenting entry-points/lists of registered aliases #594

Open
RonnyPfannschmidt opened this issue Jul 27, 2023 · 0 comments
Open

documenting entry-points/lists of registered aliases #594

RonnyPfannschmidt opened this issue Jul 27, 2023 · 0 comments
Labels
feature New feature or request

Comments

@RonnyPfannschmidt
Copy link

Is your feature request related to a problem? Please describe.

for setuptools_scm i want to document the options for entry-points + linking/summarizing their implementations
it may be necessary to move this to the right repo

i'm open to implementing this eventually but won't get to it anytime soon and would like to collect design considerations first

Describe the solution you'd like

# mkdocs.yaml
plugins:
- mkdocstrings:
    handlers:
       python-entrypoints:
          options:
             consider-distributions: [setuptools_scm] 
::: setuptools_scm.version_scheme
    handler: python-entrypoints

resulting in something like

or a table of the values

additionally it would be nice to be able to link to a expected signature/protocol for the entry-point

Describe alternatives you've considered

  • manual lists (error prone)
  • trying to alias the names (decided its not practical)

Additional context
Add any other context or screenshots about the feature request here.

@RonnyPfannschmidt RonnyPfannschmidt added the feature New feature or request label Jul 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant