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

Convert reStructuredText docstrings into Markdown #3

Open
ramnes opened this issue Oct 14, 2015 · 4 comments
Open

Convert reStructuredText docstrings into Markdown #3

ramnes opened this issue Oct 14, 2015 · 4 comments

Comments

@ramnes
Copy link
Collaborator

ramnes commented Oct 14, 2015

Postman doesn't support rST, but does support Markdown, so it would be nice to have fancier descriptions by converting rST docstrings to Markdown.

@Himura2la
Copy link

If I understand correctly, the README.rst should be converted. I can do this.

@ramnes
Copy link
Collaborator Author

ramnes commented Oct 8, 2016

Hi @Himura2la!

No, we don't want to convert the README to Markdown.

flask2postman is a little tool to generate a Postman collection from a Flask application. To do this, it iterates throught all the Flask application's view functions.

When doing this, it also read the functions docstrings to put them as description in the Postman collection.
It's done here: https://github.com/numberly/flask2postman/blob/master/flask2postman.py#L262

What we want is convert docstrings from rST to Markdown, because rST is the defacto format for Python docstrings, and Markdown is what Postman read.

I'm going to close your pull request, because it doesn't answer to what we want. Feel free to open another one if you feel like you can do this!

@Himura2la
Copy link

Sorry for making an information noise, I should have learnt what your tool is for more carefully.

@ramnes
Copy link
Collaborator Author

ramnes commented Mar 27, 2018

Or we could gently ask Postman to consider implementing rST support. 😄

postmanlabs/postman-app-support#4392

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants