sphinx-markdown-builder icon indicating copy to clipboard operation
sphinx-markdown-builder copied to clipboard

Tables are not supported

Open pmatulis opened this issue 3 years ago • 5 comments

Tables (grid-like or list-table) in reST become mangled in Markdown.

pmatulis avatar Jan 13 '21 02:01 pmatulis

Ok, thanks for reporting this. Could you create an example of this?

clayrisser avatar Jan 13 '21 05:01 clayrisser

I have the same issue. I added an example of how a table is converted for me: sphinx:

.. list-table::
   :widths: 20 80
   :header-rows: 1

   * - Name
     - Description
   * - DateValue
     - Insert a valid timestamp format or a cell reference to a timestamp. A timestamp consists out of two numbers. The number to the left of the decimal define the days since 01.01.1900. The number to the right of the decimal
       define the fraction of the day.
   * - Round
     - Optional. Defines if value should be rounded. Default is true.

markdown:


 |
| ------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |
| DateValue

                                                                            | Insert a valid timestamp format or a cell reference to a timestamp. A timestamp consists out of two numbers. The number to the left of the decimal define the days since 01.01.1900. The number to the right of the decimal
define the fraction of the day.

 |
| Round

                                                                                | Optional. Defines if value should be rounded. Default is true.

                                                                                                                                                                                              |

TizianGit avatar Jan 13 '21 15:01 TizianGit

sphinx:

+-------+-----------------------+---------------+
| Group | Charm Name            | Charm Type    |
+=======+=======================+===============+
| 1     | keystone              | Core Identity |
+-------+-----------------------+---------------+

markdown:

| Group

 | Charm Name

 | Charm Type

 |
| ------------------------------- | --------------------------------- | ------------------------------------------------------------------------------------------------------ | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- | ------- |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |
| 1

                               | keystone

pmatulis avatar Jan 14 '21 01:01 pmatulis

Thanks. I don't have time to work on this right now, but pull requests are welcome.

clayrisser avatar Jan 15 '21 00:01 clayrisser

Thanks. I don't have time to work on this right now, but pull requests are welcome.

@clayrisser Fixed in #57.

SilverRainZ avatar Dec 21 '21 03:12 SilverRainZ

@pmatulis @TizianGit I created a new plugin that addresses most issues with this implementation. It also addresses this issue.

You can try it: https://github.com/liran-funaro/sphinx-markdown-builder I haven't released an official version yet, so you'll have to install it manually:

pip3 uninstall sphinx-markdown-builder
pip3 install git+https://github.com/liran-funaro/sphinx-markdown-builder@main

liran-funaro avatar Jun 20 '23 09:06 liran-funaro

@liran-funaro I am happy to forward people to your fork if you don't mind giving me some credit in your README.md and making a pull request in my README.md file. I no longer use this project, so I lack the motivation to properly maintain it.

clayrisser avatar Jun 21 '23 16:06 clayrisser

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

clayrisser avatar Jun 24 '23 21:06 clayrisser