Skip to content

Python docs don't render Markdown tables correctly #6124

Description

@rmoff

The Python docs don't render tables nicely, and as a result are not nice for users to try and read:

CleanShot_2023-06-20_at_12 37 05

(src)

The source Markdown file is missing a linebreak after the heading. This applies to most files in the python docs.

If you view the source file in GitHub it renders it correctly as a table; the joys of Markdown is that implementations vary and Jekyll's (kramdown?) is more strict.

Adding a linebreak after the heading causes Jekyll to render it correctly

CleanShot_2023-06-20_at_12 39 30


AFAICT the docs are automagically generated by OpenAPI Generator, so need to figure out how to force it to add a linebreak; or add some post-processing to it.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions