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

docs: Update docstring of SphinxDirective (add notice)

Browse Source
This commit is contained in:
Takeshi KOMIYA 2018-03-28 22:09:38 +09:00
parent f9e2a41a48
commit a4c30027bd
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
sphinx/util/docutils.py
View File

@ -301,10 +301,12 @@ def switch_source_input(state, content):
class SphinxDirective(Directive):
"""A base class for Directives.
"""A base class for Sphinx directives.
Compared with ``docutils.parsers.rst.Directive``, this class improves
accessibility to Sphinx APIs.
This class provides helper methods for Sphinx directives.
.. note:: The subclasses of this class might not work with docutils.
This class is strongly coupled with Sphinx.
"""
@property