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

Recent upgrade of docutils seems to have broken formatting of RestructuredText descriptions #12459

Closed
schlatterbeck opened this issue Oct 30, 2022 · 4 comments
Labels

Comments

@schlatterbeck
Copy link

Describe the bug
Included graphics now have an un-rendered <figure class="align-center"> start tag and end tag </figure>
For an example see https://pypi.org/project/plot-antenna/1.0/
This worked previously for the same ReST.

When including citation references, the citation at the end now has a newline after the citation mark and no hanging indent is used. An example is also under the link above.

Note for my Nikola Blog (also ReST based) I had to include the following CSS for correctly formatting citations:

aside.footnote p {
    display: inline;
}

aside.footnote {
    padding-left: 2em;
    text-indent: -2em;
}

Expected behavior
Github displays the same ReST fine: https://github.com/schlatterbeck/plot-antenna

To Reproduce
See https://pypi.org/project/plot-antenna/1.0/
source of is the README for https://github.com/schlatterbeck/plot-antenna

My Platform
Firefox browser on Debian Bullseye

@schlatterbeck schlatterbeck added bug 🐛 requires triaging maintainers need to do initial inspection of issue labels Oct 30, 2022
@miketheman
Copy link
Member

miketheman commented Oct 31, 2022

This might be an issue with readme_renderer instead, as that project needs to expose the 'figure' class.

@miketheman miketheman removed the requires triaging maintainers need to do initial inspection of issue label Oct 31, 2022
@schlatterbeck
Copy link
Author

You mean readme-renderer?
What I reported are actually two bugs, one with the figure embedding and one with the citations. The latter seems to affect different programs internally using docutils (including my nikola blog). So maybe readme-renderer uses docutils internally?

As for the first bug: I really don't know how the figure-embedding is done.
Ralf

@di
Copy link
Member

di commented Oct 31, 2022

Yes, readme_renderer uses docutils internally for rST rendering.

I'm going to close this in favor of re-opening it at https://github.com/pypa/readme_renderer to determine if this is something that needs fixed in readme_renderer or in docutils instead -- there's nothing for PyPI to do here.

@di di closed this as completed Oct 31, 2022
@schlatterbeck
Copy link
Author

I've opened pypa/readme_renderer#264

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants