Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

docstrings/sphinx: Support cross-refs for types in "Other Parameters" sections #20

Copy link
Copy link

Description

@pawamoy
Issue body actions

Is your feature request related to a problem? Please describe.
The goal is to have a common set of features between all parsers.

Describe the solution you'd like
The Sphinx parser should be able to parse the types in "Other Parameters" section in order to enable automatic cross-references.

from griffe.docstrings.utils import parse_annotation

# annotation is a string
annotation = parse_annotation(annotation, docstring)
# annotation is unchanged, or becomes a Name or Expression! cross-refs enabled
Reactions are currently unavailable

Metadata

Metadata

Assignees

No one assigned

    Labels

    featureNew feature or requestNew feature or requestgriffe: docstringsRelated to docstring parsingRelated to docstring parsinggriffe: sphinxRelated to Sphinx-style docstringsRelated to Sphinx-style docstrings

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

    Morty Proxy This is a proxified and sanitized view of the page, visit original site.