From a4c30027bd9b575ac414b89b7a15b463bdcda2ee Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Wed, 28 Mar 2018 22:09:38 +0900 Subject: [PATCH] docs: Update docstring of SphinxDirective (add notice) --- sphinx/util/docutils.py | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/sphinx/util/docutils.py b/sphinx/util/docutils.py index b6262d793..d96ab843c 100644 --- a/sphinx/util/docutils.py +++ b/sphinx/util/docutils.py @@ -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