[Doc gen Feature request] Grid Table

[mratsim]

Nim docgen does not implement .rst grid tables at the moment.

Unfortunately Pandoc which converts document to and from multiple format outputs grid tables in reStructureText.

[kaushalmodi]

I stumbled across this today. I really hope this gets implemented.

[kaushalmodi]

Right now, nim doc is able to parse simple RST tables like this:

====== =========
Option Meaning
------ ---------
``<``  Left alignment, additional characters are added to the
       right (default for string).
``>``  Right alignment, additional characters are added to the left.
``^``  Centered , the same amount of characters is added to the
       left and the right.
``=``  Padding. If a numeric value is printed with a sign, then
       additional characters are added after the sign. Otherwise
       it behaves like "``>``". This option is only available for
       numbers (default for numbers).
====== =========

But this style of RST table, the grid style (which is also valid) is not supported:

+-----------------------------------+-----------------------------------+
| Option                            | Meaning                           |
+===================================+===================================+
| ``<``                             | Left alignment, additional        |
|                                   | characters are added to the right |
|                                   | (default for string).             |
+-----------------------------------+-----------------------------------+
| ``>``                             | Right alignment, additional       |
|                                   | characters are added to the left. |
+-----------------------------------+-----------------------------------+
| ``^``                             | Centered , the same amount of     |
|                                   | characters is added to the left   |
|                                   | and the right.                    |
+-----------------------------------+-----------------------------------+
| ``=``                             | Padding. If a numeric value is    |
|                                   | printed with a sign, then         |
|                                   | additional characters are added   |
|                                   | after the sign. Otherwise it      |
|                                   | behaves like "``>``". This option |
|                                   | is only available for numbers     |
|                                   | (default for numbers).            |
+-----------------------------------+-----------------------------------+

I get this error:

Hint: strfmt [Processing]
docs/strfmt.rst(52, 4) Error: grid table is not implemented
Error: unhandled exception: grid table is not implemented [ERecoverableError]

/cc @kdheepak

[kaushalmodi]

@kdheepak Wanted to let you know that the feature requested to Pandoc (to generate simple tables instead of grid when possible) has been implemented.

I haven't tested it though as I don't have Haskell toolchain installed. So I can try it out whenever the next Pandoc release is out.

Letting you know so that you don't spend more time on this issue (if you have already started), and may be this issue can be closed once the next Pandoc version is released and tested.

[kaushalmodi]

@mratsim

Pandoc 2.6 got released yesterday.

With that, now Pandoc does not create Grid tables if not needed. It tries to export to the simple tables (that Nim supports) by default.

[stale]

This issue has been automatically marked as stale because it has not had recent activity. If you think it is still a valid issue, write a comment below; otherwise it will be closed. Thank you for your contributions.