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

RestructuredText: warning and note directives are not properly rendered #1682

Open
berndschatz opened this issue Apr 11, 2023 · 12 comments
Open
Labels
keep Label to avoid being marked as stale

Comments

@berndschatz
Copy link

text of warning / note directives should be rendered in a box or/and in another color.

Currently it looks like this:

note

This is a note

but it should look somehow like here -->

2023-04-11-114318_1088x130_scrot

see also -->
https://sublime-and-sphinx-guide.readthedocs.io/en/latest/notes_warnings.html

IMHO this would be a big improvement for the readability of technical documentation with less effort for you for the implementation.

@berndschatz berndschatz changed the title RestructuredText directives warning and note directives are not properly rendered on github RestructuredText: warning and note directives are not properly rendered on github Apr 11, 2023
@berndschatz berndschatz changed the title RestructuredText: warning and note directives are not properly rendered on github RestructuredText: warning and note directives are not properly rendered Apr 11, 2023
@ichordev
Copy link

Notes used to render with a little blue "info" icon, and warnings with a little yellow "warning" icon... but not anymore.

@flying-sheep
Copy link
Contributor

@berndschatz
Copy link
Author

Maybe this broke it? https://github.blog/changelog/2023-12-14-new-markdown-extension-alerts-provide-distinctive-styling-for-significant-content/

This is markdown (that is designed for small blog entries),
we use/need RestructuredText (that is designed for technical documentation).

@flying-sheep
Copy link
Contributor

flying-sheep commented Mar 19, 2024

Hold your horses, I’m with you haha. In this community discussion, they describe that they broke the rendering for the old markdown way of doing admonitions.

What I’m implying (but could have been clear about) is that maybe they still make rST render to whatever intermediate representation the old Markdown syntax rendered to and that way broke it?

Or maybe they never supported it, I don’t remember. Since they do support admonition rendering in Markdown, they should make rST and Asciidoc admonitions render the same way.

@berndschatz
Copy link
Author

berndschatz commented Mar 19, 2024

Don't know what they do, the docutils works fine, so i assume they have some own stuff: post/pre-processor
before / after using the docutils !?
Or do they implement a complete own ResT parser !?

PS: Regarding automated testing, there are probably still a few areas for improvement for ResT (and markdown):

Copy link

Stale issue message

@flying-sheep
Copy link
Contributor

Not-a-stale-issue response

@humans please pin and make the bot go away thanks

@ErraticMaker
Copy link

ErraticMaker commented Jul 30, 2024

Just for reference #68 was closed several years ago, because at the time it couldn't be implemented. I'm hoping that things have changed enough since then that'll be possible to provide the same experience to ReST than it is available with GFM.

Copy link

Stale issue message

@flying-sheep
Copy link
Contributor

Still not stale. Please please add a label that shuts up the bot!

@flying-sheep
Copy link
Contributor

@jmeridth could you please take a look here? Either #68 needs to be reopened or this needs to be triaged and labelled correctly.

The closing reason for #68 is no longer valid

@jmeridth
Copy link
Member

@jmeridth could you please take a look here? Either #68 needs to be reopened or this needs to be triaged and labelled correctly.

The closing reason for #68 is no longer valid

@flying-sheep Taking a look. I've also added the keep label to avoid being flagged by the stale bot. Thanks for the bump.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
keep Label to avoid being marked as stale
Projects
None yet
Development

No branches or pull requests

5 participants