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

Markdown sections embedded docs #83

Open
crisrivlop opened this issue Nov 22, 2024 · 0 comments
Open

Markdown sections embedded docs #83

crisrivlop opened this issue Nov 22, 2024 · 0 comments
Labels
feature Request for new feature or improvement

Comments

@crisrivlop
Copy link

crisrivlop commented Nov 22, 2024

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

@crisrivlop crisrivlop added the feature Request for new feature or improvement label Nov 22, 2024
@crisrivlop crisrivlop changed the title Markdown sections embedded un docs Markdown sections embedded docs Nov 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature Request for new feature or improvement
Projects
None yet
Development

No branches or pull requests

1 participant