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

Merge pull request #4788 from tk0miya/4787_update_docs

Browse Source 
Fix #4787: Update docstrings for add_directive()
This commit is contained in:
Takeshi KOMIYA 2018-03-29 22:06:39 +09:00 committed by GitHub
commit d16c7a196f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
sphinx/application.py
View File

@ -671,7 +671,7 @@ class Sphinx(object):
function and determine whether the directive has content, arguments function and determine whether the directive has content, arguments
and options, respectively. **This style is deprecated.** and options, respectively. **This style is deprecated.**
- In the docutils 0.5 style, *directiveclass* is the directive class. - In the docutils 0.5 style, *obj* is the directive class.
It must already have attributes named *has_content*, It must already have attributes named *has_content*,
*required_arguments*, *optional_arguments*, *required_arguments*, *optional_arguments*,
*final_argument_whitespace* and *option_spec* that correspond to the *final_argument_whitespace* and *option_spec* that correspond to the
@ -687,12 +687,22 @@ class Sphinx(object):
.. code-block:: python .. code-block:: python
from docutils.parsers.rst import directives from docutils.parsers.rst import Directive, directives
add_directive('literalinclude', literalinclude_directive,
content = 0, arguments = (1, 0, 0), class LiteralIncludeDirective(Directive):
linenos = directives.flag, has_content = True
language = directives.unchanged, required_arguments = 1
encoding = directives.encoding) optional_arguments = 0
final_argument_whitespace = True
option_spec = {
'class': directives.class_option,
'name': directives.unchanged,
}
def run(self):
...
add_directive('literalinclude', LiteralIncludeDirective)
.. versionchanged:: 0.6 .. versionchanged:: 0.6
Docutils 0.5-style directive classes are now supported. Docutils 0.5-style directive classes are now supported.