Skip to content

Allow to mark function from the docstring when using autodoc #295

@Jackenmen

Description

@Jackenmen

Similarly to how :meta private:, :meta public:, or :meta hide-value: in Sphinx work (see the docs here), I would want to be able to mark function as a decorator/abstractmethod/etc using something like this:

def function():
    """
    Description of the method

    :trio decorator:
    :trio classmethod:
    """

It should probably be possible to base its implementation on Sphinx's own implementation used for the :meta: fields.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions