-
Notifications
You must be signed in to change notification settings - Fork 90
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 #264
Comments
@schlatterbeck Thanks for the report - you mention citation references, but there are none in the example RST file you referenced. |
Resolves pypa#264 Signed-off-by: Mike Fiedler <miketheman@gmail.com>
@miketheman : When you scroll to the end you see something like
I would call that a citation reference, maybe I'm using the wrong terminology.
The cited css snipped does that for me in my nikola blog. Can we re-open this issue? Seems I cannot. Or should I open a separate issue? |
@schlatterbeck thanks for clarifying - docutils calls those footnotes, not citations - very similar, but different in their HTML counterparts and rendering - hence the confusion. I've added a new pull request that confirms both footnotes and citations behavior, which confirms there's no further code change necessary on the library side. For the visualization aspect, we may need some CSS tweaks on the warehouse side for display. |
@miketheman thanks for the followup, I wasn't aware that the numerical and non-numerical footnotes are different beasts. Thanks |
Let's let the updated version hit warehouse first, confirm that the figure works first. |
@miketheman : Seems your changes are in warehouse, the figure bug is gone from my project: But the footnote formatting is still broken. The fix as already reported involves a slight change to the CSS. |
As noted in pypa/readme_renderer#264 With these changes, the footnotes are styled in a more visually-pleasing manner. Signed-off-by: Mike Fiedler <miketheman@gmail.com>
@schlatterbeck Thanks for the ping - I've added the correction in a PR to warehouse - follow that one for resolution! |
As noted in pypa/readme_renderer#264 With these changes, the footnotes are styled in a more visually-pleasing manner. Signed-off-by: Mike Fiedler <miketheman@gmail.com> Signed-off-by: Mike Fiedler <miketheman@gmail.com>
Description
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:
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
The text was updated successfully, but these errors were encountered: