IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Add warning to docstring of math nodes

Browse Source
This commit is contained in:
Takeshi KOMIYA 2018-05-19 16:05:33 +09:00
parent ac523c637a
commit 46af04694a
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
sphinx/addnodes.py
View File

@ -193,6 +193,9 @@ class production(nodes.Part, nodes.Inline, nodes.FixedTextElement):
class math(nodes.math):
"""Node for inline equations.
.. warning:: This node is provided to keep compatibility only.
It will be removed in nearly future. Don't use this from your extension.
.. deprecated:: 1.8
Use ``docutils.nodes.math`` instead.
"""
@ -211,6 +214,9 @@ class math(nodes.math):
class math_block(nodes.math_block):
"""Node for block level equations.
.. warning:: This node is provided to keep compatibility only.
It will be removed in nearly future. Don't use this from your extension.
.. deprecated:: 1.8
"""
@ -227,6 +233,9 @@ class math_block(nodes.math_block):
class displaymath(math_block):
"""Node for block level equations.
.. warning:: This node is provided to keep compatibility only.
It will be removed in nearly future. Don't use this from your extension.
.. deprecated:: 1.8
"""