Skip to content

Top level section header ignored in text/reST package description, not in text/markdown #12204

@dnicolodi

Description

@dnicolodi

When using text/reST for the package description in the METADATA package dist-info file, the top level section header is omitted in the rendered page, however it is included when the description is in text/markdown format.

This can be easily verified running python -m readme_renderer README.rst vs python -m readme_renderer README.rst.

Is this intentional? Looking at the docutils configuration used in readme_renderer it looks so. However, why are markdown and reST threated differently?

Metadata

Metadata

Assignees

No one assigned

    Labels

    bug 🐛requires triagingmaintainers need to do initial inspection of issue

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions