Skip to content

Markdown sections embedded docs #83

@crisrivlop

Description

@crisrivlop

Feature description:

Would it be great if markdown sections inside pydocs were able to use.

For example i am adding string docs to my python program and i wanted to describe the parameter list in a markdown table or if i wanted to add a markdown note (as GitHub note).

Problem and motivation:

I am very interested to document a python program using some sections written in markdown.

Is this something you're interesed in working on?

Yes

Additional notes:
This issue also will solve #82

Metadata

Metadata

Assignees

No one assigned

    Labels

    featureRequest for new feature or improvementstaleAwaiting input from creator for prolonged time period

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions