-
Notifications
You must be signed in to change notification settings - Fork 103
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
Sphinx for reStructuredText (reST): Parser falling short #300
Comments
Hi @vanledem, This is a limitation by how much of the ReST syntax we support and convert into corresponding Markdown format. There's also the issue that ReST syntax elements don't have a counterpart in Markdown. If you have any suggestions on how to convert a particular ReST syntax to Markdown, feel free to include those here. Then we'd still need someone willing to work on the code to convert the syntax. :) I suppose we could also consider looking into pandoc for ReST -> Markdown conversion |
Hello @NiklasRosenstein, As I mentionned previously, I'm far from being an expect here. Best regards |
Hello,
I have been using your tool for a few months and it is great for making small docstrings in ReST where the amount of information stays significantly low (typically 10 lines with the arguments and the return).
However once I use all the functionalities that are available in ReST which allow for a much more complex output in Sphinx, I'm unable to obtain the equivalent result.
Would It be possible to manage those Sphinx-ReST functionalities into the tool (I will update when I'm home with an example)?
Currently, I'm using directly Sphinx to produce the documentation of each project separately and then I'm using pydoc-markdown to integrate with CI/CD the documentation of the differents projects to put it into a single gitlab pages.
Thanks you for your time, I'm happy to help you to investigate and implement a better system on that specific subject but I fear it is above my pay-grade for now.
Docstring raw
Sphinx output:
Pydoc-Markdown output:
PS: Update with Example
The text was updated successfully, but these errors were encountered: