Regarding sphinx directives

49 views
Skip to first unread message

Janmenjaya Panda

unread,
Feb 6, 2024, 2:37:50 PM2/6/24
to sage-devel
Hello,
Is .. raw:: latex sphinx directive supported by sage (for documentations)?

I searched for the list of sphinx directives suppored/ allowed by sage and I got the following info:

Note about Sphinx directives vs. other blocks

The main Sphinx directives that are used in Sage are:

.. MATH::.. NOTE::.. PLOT::.. RUBRIC::.. SEEALSO::.. TODO::.. TOPIC:: and .. WARNING::.

They must be written exactly as above, so for example WARNING:: or .. WARNING :: will not work.

Some other directives are also available, but less frequently used, namely:

.. MODULEAUTHOR::.. automethod::.. autofunction::.. image::.. figure::.

Other blocks shall not be used as directives; for example .. ALGORITHM:: will not be shown at all.


Is the above mentioned list an exhaustive list of sphinx directives allowed in sage?

Kwankyu Lee

unread,
Feb 7, 2024, 8:50:50 PM2/7/24
to sage-devel
On Wednesday, February 7, 2024 at 4:37:50 AM UTC+9 Janmenjaya Panda wrote:
Hello,
Is .. raw:: latex sphinx directive supported by sage (for documentations)?

It does not work with me. I don't know why.

...


Is the above mentioned list an exhaustive list of sphinx directives allowed in sage?


As far as I know, Sage supports whatever directives that are supported by Sphinx and docutils.  
 
Reply all
Reply to author
Forward
0 new messages