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

Small API change.

Browse Source
This commit is contained in:
Georg Brandl 2009-01-04 20:43:15 +01:00
parent 27bc4e3189
commit 04689accd0
2 changed files with 6 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
sphinx/ext/autodoc.py
View File

@ -212,8 +212,9 @@ class RstGenerator(object):
docstrings.append(initdocstring) docstrings.append(initdocstring)
# the default is only the class docstring # the default is only the class docstring
# make sure we get Unicode docstrings # make sure we have Unicode docstrings, then sanitize and split into lines
return [force_decode(docstring, encoding) for docstring in docstrings] return [prepare_docstring(force_decode(docstring, encoding))
for docstring in docstrings]
def process_doc(self, docstrings, what, name, obj): def process_doc(self, docstrings, what, name, obj):
"""Let the user process the docstrings.""" """Let the user process the docstrings."""
@ -462,8 +463,7 @@ class RstGenerator(object):
# add content from docstrings # add content from docstrings
if not no_docstring: if not no_docstring:
encoding = analyzer and analyzer.encoding encoding = analyzer and analyzer.encoding
docstrings = map(prepare_docstring, docstrings = self.get_doc(what, todoc, encoding)
self.get_doc(what, todoc, encoding))
for i, line in enumerate(self.process_doc(docstrings, what, for i, line in enumerate(self.process_doc(docstrings, what,
fullname, todoc)): fullname, todoc)):
self.result.append(indent + line, sourcename, i) self.result.append(indent + line, sourcename, i)

6
tests/test_autodoc.py
View File

@ -15,7 +15,6 @@ from util import *
from docutils.statemachine import ViewList from docutils.statemachine import ViewList
from sphinx.ext.autodoc import RstGenerator, cut_lines, between from sphinx.ext.autodoc import RstGenerator, cut_lines, between
from sphinx.util.docstrings import prepare_docstring
def setup_module(): def setup_module():
@ -174,7 +173,7 @@ def test_format_signature():
def test_get_doc(): def test_get_doc():
def getdocl(*args): def getdocl(*args):
ds = map(prepare_docstring, gen.get_doc(*args)) ds = gen.get_doc(*args)
# for testing purposes, concat them and strip the empty line at the end # for testing purposes, concat them and strip the empty line at the end
return sum(ds, [])[:-1] return sum(ds, [])[:-1]
@ -240,8 +239,7 @@ def test_get_doc():
def test_docstring_processing(): def test_docstring_processing():
def process(what, name, obj): def process(what, name, obj):
return list(gen.process_doc(map(prepare_docstring, gen.get_doc(what, obj)), return list(gen.process_doc(gen.get_doc(what, obj), what, name, obj))
what, name, obj))
class E: class E:
def __init__(self): def __init__(self):