flask2postman
flask2postman copied to clipboard
numberly
Convert reStructuredText docstrings into Markdown
Postman doesn't support rST, but does support Markdown, so it would be nice to have fancier descriptions by converting rST docstrings to Markdown.
If I understand correctly, the README.rst should be converted. I can do this.
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!
Sorry for making an information noise, I should have learnt what your tool is for more carefully.
Or we could gently ask Postman to consider implementing rST support. :smile:
https://github.com/postmanlabs/postman-app-support/issues/4392