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

Warn if doctest blocks don't contain code.

Browse Source
This commit is contained in:
Georg Brandl 2008-12-15 11:29:07 +01:00
parent 44b0929669
commit 7debd67c23
2 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGES
View File

@ -1,6 +1,8 @@
Release 0.5.1 (in development) Release 0.5.1 (in development)
============================== ==============================
* Warn if a doctest extension block doesn't contain any code.
* Fix the handling of ``:param:`` and ``:type:`` doc fields when * Fix the handling of ``:param:`` and ``:type:`` doc fields when
they contain markup (especially cross-referencing roles). they contain markup (especially cross-referencing roles).

8
sphinx/ext/doctest.py
View File

@ -229,8 +229,12 @@ Doctest summary
return isinstance(node, (nodes.literal_block, nodes.comment)) \ return isinstance(node, (nodes.literal_block, nodes.comment)) \
and node.has_key('testnodetype') and node.has_key('testnodetype')
for node in doctree.traverse(condition): for node in doctree.traverse(condition):
code = TestCode(node.has_key('test') and node['test'] or node.astext(), source = node.has_key('test') and node['test'] or node.astext()
type=node.get('testnodetype', 'doctest'), if not source:
self.warn('no code/output in %s block at %s:%s' %
(node.get('testnodetype', 'doctest'),
self.env.doc2path(docname), node.line))
code = TestCode(source, type=node.get('testnodetype', 'doctest'),
lineno=node.line, options=node.get('options')) lineno=node.line, options=node.get('options'))
node_groups = node.get('groups', ['default']) node_groups = node.get('groups', ['default'])
if '*' in node_groups: if '*' in node_groups: