|
58 | 58 |
|
59 | 59 | # fmt: off
|
60 | 60 | DIRECTIVES_CONTAINING_RST = [
|
61 |
| - # standard docutils ones |
| 61 | + # reStructuredText directives: |
62 | 62 | 'admonition', 'attention', 'caution', 'class', 'compound', 'container',
|
63 | 63 | 'danger', 'epigraph', 'error', 'figure', 'footer', 'header', 'highlights',
|
64 |
| - 'hint', 'image', 'important', 'include', 'line-block', 'list-table', 'meta', |
65 |
| - 'note', 'parsed-literal', 'pull-quote', 'replace', 'sidebar', 'tip', 'topic', |
66 |
| - 'warning', |
67 |
| - # Sphinx and Python docs custom ones |
68 |
| - 'acks', 'attribute', 'autoattribute', 'autoclass', 'autodata', |
69 |
| - 'autoexception', 'autofunction', 'automethod', 'automodule', |
70 |
| - 'availability', 'centered', 'cfunction', 'class', 'classmethod', 'cmacro', |
71 |
| - 'cmdoption', 'cmember', 'confval', 'cssclass', 'ctype', |
72 |
| - 'currentmodule', 'cvar', 'data', 'decorator', 'decoratormethod', |
73 |
| - 'deprecated-removed', 'deprecated(?!-removed)', 'describe', 'directive', |
74 |
| - 'doctest', 'envvar', 'event', 'exception', 'function', 'glossary', |
75 |
| - 'highlight', 'highlightlang', 'impl-detail', 'index', 'literalinclude', |
76 |
| - 'method', 'miscnews', 'module', 'moduleauthor', 'opcode', 'pdbcommand', |
77 |
| - 'program', 'role', 'sectionauthor', 'seealso', |
78 |
| - 'sourcecode', 'staticmethod', 'tabularcolumns', 'testcode', 'testoutput', |
79 |
| - 'testsetup', 'toctree', 'todo', 'todolist', 'versionadded', |
80 |
| - 'versionchanged', 'c:function', 'coroutinefunction' |
| 64 | + 'hint', 'image', 'important', 'line-block', 'list-table', 'math', 'meta', |
| 65 | + 'note', 'parsed-literal', 'pull-quote', 'replace', 'sidebar', 'tip', |
| 66 | + 'topic', 'warning', |
| 67 | + # Added by Sphinx: |
| 68 | + 'acks', 'centered', 'codeauthor', 'default-domain', 'deprecated(?!-removed)', |
| 69 | + 'describe', 'highlight', 'hlist', 'index', 'literalinclude', 'moduleauthor', |
| 70 | + 'object', 'only', 'rst-class', 'sectionauthor', 'seealso', 'tabularcolumns', |
| 71 | + 'toctree', 'versionadded', 'versionchanged', |
| 72 | + # Added by Sphinx (since removed): |
| 73 | + 'highlightlang', # removed in Sphinx 4.0 |
| 74 | + # Added by Sphinx (Standard domain): |
| 75 | + 'cmdoption', 'envvar', 'glossary', 'option', 'productionlist', 'program', |
| 76 | + # Added by Sphinx (Python domain): |
| 77 | + 'py:attribute', 'py:class', 'py:classmethod', 'py:currentmodule', 'py:data', |
| 78 | + 'py:decorator', 'py:decoratormethod', 'py:exception', 'py:function', |
| 79 | + 'py:method', 'py:module', 'py:property', 'py:staticmethod', |
| 80 | + 'attribute', 'class', 'classmethod', 'currentmodule', 'data', |
| 81 | + 'decorator', 'decoratormethod', 'exception', 'function', |
| 82 | + 'method', 'module', 'property', 'staticmethod', |
| 83 | + # Added by Sphinx (C domain): |
| 84 | + 'c:alias', 'c:enum', 'c:enumerator', 'c:function', 'c:macro', 'c:member', |
| 85 | + 'c:struct', 'c:type', 'c:union', 'c:var', |
| 86 | + 'cfunction', 'cmacro', 'cmember', 'ctype', 'cvar', |
| 87 | + # Added by Sphinx (sphinx.ext.todo): |
| 88 | + 'todo', 'todolist', |
| 89 | + # Added in Sphinx's own documentation only: |
| 90 | + 'confval', 'event', |
| 91 | + # Added in the Python documentation (directives): |
| 92 | + 'audit-event', 'audit-event-table', 'availability', |
| 93 | + 'deprecated-removed', 'impl-detail', 'miscnews', |
| 94 | + # Added in the Python documentation (objects with implicit directives): |
| 95 | + '2to3fixer', 'opcode', 'pdbcommand', |
| 96 | + # Added in the Python documentation (Python domain): |
| 97 | + 'coroutinefunction', 'coroutinemethod', 'abstractmethod', |
| 98 | + 'awaitablefunction', 'awaitablemethod', |
| 99 | + 'py:coroutinefunction', 'py:coroutinemethod', 'py:abstractmethod', |
| 100 | + 'py:awaitablefunction', 'py:awaitablemethod', |
81 | 101 | ]
|
82 | 102 |
|
83 | 103 | DIRECTIVES_CONTAINING_ARBITRARY_CONTENT = [
|
84 |
| - # standard docutils ones |
85 |
| - 'contents', 'csv-table', 'date', 'default-role', 'include', 'raw', |
86 |
| - 'restructuredtext-test-directive', 'role', 'rubric', 'sectnum', 'table', |
87 |
| - 'target-notes', 'title', 'unicode', |
88 |
| - # Sphinx and Python docs custom ones |
89 |
| - 'productionlist', 'code-block', |
| 104 | + # reStructuredText directives: |
| 105 | + 'code', 'code-block', 'contents', 'csv-table', 'date', 'default-role', |
| 106 | + 'include', 'raw', 'restructuredtext-test-directive', 'role', 'rubric', |
| 107 | + 'section-numbering', 'sectnum', 'sourcecode', 'table', 'target-notes', |
| 108 | + 'title', 'unicode', |
| 109 | + # Added by Sphinx (core): |
| 110 | + 'cssclass', |
| 111 | + # Added by Sphinx (Standard domain): |
| 112 | + 'productionlist', |
| 113 | + # Added by Sphinx (C domain): |
| 114 | + 'c:namespace', 'c:namespace-pop', 'c:namespace-push', |
| 115 | + # Added by Sphinx (sphinx.ext.autodoc): |
| 116 | + 'autoattribute', 'autoclass', 'autodata', 'autodecorator', 'autoexception', |
| 117 | + 'autofunction', 'automethod', 'automodule', 'autonewtypedata', |
| 118 | + 'autonewvarattribute', 'autoproperty', |
| 119 | + # Added by Sphinx (sphinx.ext.doctest): |
| 120 | + 'doctest', 'testcleanup', 'testcode', 'testoutput', 'testsetup', |
| 121 | + # Added in the Python documentation: |
| 122 | + 'limited-api-list', |
90 | 123 | ]
|
91 | 124 |
|
92 | 125 | # fmt: on
|
|
0 commit comments