How to create custom admonitions in custom directive sphinx?

Question

I have created a custom directive 'limitation' in Sphinx which mentions "Limitation" of a certain product. I want that the limitation be written within a colored box that is similar to 'note' or 'warning' directives with 'limitation' written as the title instead of 'note' or 'warning'. I want this to be handled by my custom directive 'limitation' itself.

Is there any way to do this?

Possible duplicate of [How to change format of Warning admonition or add Caution in Sphinx HTML output](https://stackoverflow.com/questions/34498027/how-to-change-format-of-warning-admonition-or-add-caution-in-sphinx-html-output) — Steve Piercy, Feb 12 '19 at 18:44

score 3 · Answer 1 · answered Nov 21 '19 at 22:27

3

You can use admonition directly from Docutils:

 .. admonition:: Limitation

    Description of the limitations ...

Check http://docutils.sourceforge.net/docs/ref/rst/directives.html for more information.

answered Nov 21 '19 at 22:27

Yao Yue

31
2

How to create custom admonitions in custom directive sphinx?

1 Answers1