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

#2092: Add support for todo directive

Browse Source
This commit is contained in:
Sgiath 2015-10-19 14:21:03 +02:00
parent 5f09ecd4cf
commit 3cf04907b6
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
sphinx/ext/napoleon/docstring.py
View File

@ -144,6 +144,7 @@ class GoogleDocstring(UnicodeMixin):
'raises': self._parse_raises_section, 'raises': self._parse_raises_section,
'references': self._parse_references_section, 'references': self._parse_references_section,
'see also': self._parse_see_also_section, 'see also': self._parse_see_also_section,
'todo': self._parse_todo_section,
'warning': self._parse_warning_section, 'warning': self._parse_warning_section,
'warnings': self._parse_warning_section, 'warnings': self._parse_warning_section,
'warns': self._parse_warns_section, 'warns': self._parse_warns_section,
@ -606,6 +607,10 @@ class GoogleDocstring(UnicodeMixin):
lines = self._consume_to_next_section() lines = self._consume_to_next_section()
return self._format_admonition('seealso', lines) return self._format_admonition('seealso', lines)
def _parse_todo_section(self, section):
lines = self._consume_to_next_section()
return self._format_admonition('todo', lines)
def _parse_warning_section(self, section): def _parse_warning_section(self, section):
lines = self._consume_to_next_section() lines = self._consume_to_next_section()
return self._format_admonition('warning', lines) return self._format_admonition('warning', lines)