Missing Markdown Features

[clayrisser]

I'm using Matthew Brett's doctree2md to actually do the conversion.

His markdown writer is a great start, but certainly not complete.

In this issue, please list any markdown features that are broken, missing, or incomplete.

If the community would star the features they most want, that will help me prioritize which ones to tackle first.

[utf]

Thanks for developing this, I've been looking for a project like this for a long time.

The markdown features that I would be most interest in are, "topic", "option_list", "raw" and "desc".

[clayrisser]

I just added support for markdown tables created from https://pypi.org/project/sphinx-markdown-tables

[clayrisser]

I just added support for inline html

[Liam-Deacon]

I've got warnings over the following elements not being supported yet in markdown (almost certainly related to #5 with napoleon): "classifier", "seealso", "citation", "autosummary_toc", as well as "caption".

[clayrisser]

Thanks @Lightslayer, I'll try and look into this sometime this week.

[danielloader]

Hey, great tool, started using it recently.

My suggestion would be: WARNING: The autosummary_toc element not yet supported in Markdown.

Example output:

Compared to the RTD rendering in html:

[clayrisser]

@danielloader thanks for this information. Also contributions are most welcome.

[pmatulis]

Support is missing for referencing a document with these elements:

:doc:`label <some_page>`

:ref:`label <some_page>`

[clayrisser]

@pmatulis thanks for documenting this. I do not have time to add support for that at this moment, but a pull request is welcome.

[clayrisser]

DISCONTINUED: This project is no longer maintained. The active version of this project is now being maintained at liran-funaro/sphinx-markdown-builder.