QuantEcon / sphinxcontrib-jupyter

A Sphinx Extension for Generating Jupyter Notebooks
BSD 3-Clause "New" or "Revised" License
74 stars 23 forks source link

Docutils standard directives like [warning, caution, tip etc.] are not rendered #338

Open olippuner opened 2 years ago

olippuner commented 2 years ago

When creating Juypter notebooks some important standard directives supported by Sphinx (and implemented in Docutils) like warning, caution and tip are not rendered. Containing text is just rendered but no warning-box etc. decoration is rendered.

RST-Text:

.. warning::

Please respect...

.. attention::

When you do...

.. caution::

In situations where ..

Just renders to:

Please respect... When you do... In situations where ..

Can you please implement rendering of these standard directives:

https://docutils.sourceforge.io/docs/ref/rst/directives.html#caution https://docutils.sourceforge.io/docs/ref/rst/directives.html#warning etc.

directive "note" works and renders to:

Note

The Python and NumPy do some text of some a note

Rendering a warning directive to something like given below, whould be fine:

Warning

This is some undercover text, but strictly spoken it should be a warning.

This would give this great SPHINX extension another significant boost in usage value.

I looked at the code to juge if I could be able to do that on my own, but I could not even find out the code entry point and the control flow of the package programs that happens when I do "make Jupyter". It need to be done by the specialists or authors.