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 in 0.5 bugfixes.

Browse Source
This commit is contained in:
Georg Brandl 2008-12-15 12:33:24 +01:00
commit 69ff09917c
3 changed files with 27 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
CHANGES
View File

@ -31,6 +31,13 @@ New features added
Release 0.5.1 (in development) Release 0.5.1 (in development)
============================== ==============================
* Don't crash on failing doctests with non-ASCII characters.
* Don't crash on writing status messages and warnings containing
unencodable characters.
* 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).

15
sphinx/application.py
View File

@ -149,13 +149,20 @@ class Sphinx(object):
def warn(self, message): def warn(self, message):
self._warncount += 1 self._warncount += 1
self._warning.write('WARNING: %s\n' % message) try:
self._warning.write('WARNING: %s\n' % message)
except UnicodeEncodeError:
encoding = getattr(self._warning, 'encoding', 'ascii')
self._warning.write(('WARNING: %s\n' % message).encode(encoding, 'replace'))
def info(self, message='', nonl=False): def info(self, message='', nonl=False):
if nonl: try:
self._status.write(message) self._status.write(message)
else: except UnicodeEncodeError:
self._status.write(message + '\n') encoding = getattr(self._status, 'encoding', 'ascii')
self._status.write(message.encode(encoding, 'replace'))
if not nonl:
self._status.write('\n')
self._status.flush() self._status.flush()
# general extensibility interface # general extensibility interface

12
sphinx/ext/doctest.py
View File

@ -13,6 +13,7 @@
import re import re
import sys import sys
import time import time
import codecs
import StringIO import StringIO
from os import path from os import path
# circumvent relative import # circumvent relative import
@ -172,7 +173,8 @@ class DocTestBuilder(Builder):
date = time.strftime('%Y-%m-%d %H:%M:%S') date = time.strftime('%Y-%m-%d %H:%M:%S')
self.outfile = file(path.join(self.outdir, 'output.txt'), 'w') self.outfile = codecs.open(path.join(self.outdir, 'output.txt'),
'w', encoding='utf-8')
self.outfile.write('''\ self.outfile.write('''\
Results of doctest builder run on %s Results of doctest builder run on %s
==================================%s ==================================%s
@ -232,8 +234,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: