Skip to content
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

RST tables multirow cells rendering #182

Closed
marian-code opened this issue Jan 18, 2021 · 1 comment · Fixed by #245
Closed

RST tables multirow cells rendering #182

marian-code opened this issue Jan 18, 2021 · 1 comment · Fixed by #245

Comments

@marian-code
Copy link

As I understand this is the lib that powers PyPI REDME rendering so I post this question here.

The problem

PyPI renders multirow cells in a way that it essentially ignores them which messes up the following rows. I have first encounterd this problem when trying to publish package to PyPI: https://pypi.org/project/ssh-utilities/ .

Minimal reproducible example

+---------------+---------------+
| title1        | title2        |
+===============+===============+
| col1          | col2          |
+---------------+---------------+
| mutirow       | cell1         |
|               +---------------+
|               | cell2         |
+---------------+---------------+
| singlerow     | cell3         |
+---------------+---------------+

Render this rst code with readme-renderer

python -m readme_renderer README.rst -o README.html

You will get this:
example

In the picture you can see the cell2 is incorrectly possitioned in the first column.

As far as I know RST is not supposed to render like this. So is this a know bug? Does any workaround exist? or is this on purpose?

@miketheman
Copy link
Member

Reviewing older issues, this one wasn't responded to.

This does appear to be a missing part of the functionality, as docutils supports this kind of table layout.

It's likely due to us stripping out the necessary directives to support this view during the clean() phase.
I'll add some tests and figure out the necessary directives to support this.

miketheman added a commit to miketheman/readme_renderer that referenced this issue Jul 3, 2022
Previously exlcuded directives made for incorrect rendering of rst table
cells spanning more than a single column or row.

Fixes pypa#182

Signed-off-by: Mike Fiedler <miketheman@gmail.com>
miketheman added a commit to miketheman/readme_renderer that referenced this issue Jul 3, 2022
Previously exlcuded directives made for incorrect rendering of rst table
cells spanning more than a single column or row.

Fixes pypa#182

Signed-off-by: Mike Fiedler <miketheman@gmail.com>
@di di closed this as completed in #245 Jul 6, 2022
di pushed a commit that referenced this issue Jul 6, 2022
Previously exlcuded directives made for incorrect rendering of rst table
cells spanning more than a single column or row.

Fixes #182

Signed-off-by: Mike Fiedler <miketheman@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants