-
Notifications
You must be signed in to change notification settings - Fork 3.4k
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
Comments
Notes used to render with a little blue "info" icon, and warnings with a little yellow "warning" icon... but not anymore. |
This is markdown (that is designed for small blog entries), |
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. |
Don't know what they do, the docutils works fine, so i assume they have some own stuff: post/pre-processor PS: Regarding automated testing, there are probably still a few areas for improvement for ResT (and markdown): |
Stale issue message |
Not-a-stale-issue response @humans please pin and make the bot go away thanks |
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 |
Stale issue message |
Still not stale. Please please add a label that shuts up the bot! |
@flying-sheep Taking a look. I've also added the |
text of warning / note directives should be rendered in a box or/and in another color.
Currently it looks like this:
but it should look somehow like here -->
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.
The text was updated successfully, but these errors were encountered: