mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
Fix strange reportings of line numbers for warnings generated from
autodoc-included docstrings, due to different behavior depending on docutils version.
This commit is contained in:
4
CHANGES
4
CHANGES
@@ -1,6 +1,10 @@
|
||||
Release 1.0.6 (in development)
|
||||
==============================
|
||||
|
||||
* Fix strange reportings of line numbers for warnings generated from
|
||||
autodoc-included docstrings, due to different behavior depending
|
||||
on docutils version.
|
||||
|
||||
* Several fixes to the C++ domain.
|
||||
|
||||
|
||||
|
||||
@@ -107,7 +107,7 @@ class AutodocReporter(object):
|
||||
return getattr(self.reporter, name)
|
||||
|
||||
def system_message(self, level, message, *children, **kwargs):
|
||||
if 'line' in kwargs:
|
||||
if 'line' in kwargs and 'source' not in kwargs:
|
||||
try:
|
||||
source, line = self.viewlist.items[kwargs['line']]
|
||||
except IndexError:
|
||||
@@ -676,7 +676,7 @@ class Documenter(object):
|
||||
# make sure that the result starts with an empty line. This is
|
||||
# necessary for some situations where another directive preprocesses
|
||||
# reST and no starting newline is present
|
||||
self.add_line(u'', '')
|
||||
self.add_line(u'', '<autodoc>')
|
||||
|
||||
# format the object's signature, if any
|
||||
sig = self.format_signature()
|
||||
|
||||
@@ -26,3 +26,9 @@ Just testing a few autodoc possibilities...
|
||||
.. autoclass:: CustomDict
|
||||
:show-inheritance:
|
||||
:members:
|
||||
|
||||
|
||||
.. automodule:: autodoc_fodder
|
||||
:noindex:
|
||||
|
||||
.. autoclass:: MarkupError
|
||||
|
||||
@@ -31,6 +31,9 @@ def teardown_module():
|
||||
html_warnfile = StringIO()
|
||||
|
||||
ENV_WARNINGS = """\
|
||||
%(root)s/autodoc_fodder.py:docstring of autodoc_fodder\\.MarkupError:2: \
|
||||
\\(WARNING/2\\) Explicit markup ends without a blank line; unexpected \
|
||||
unindent\\.\\n?
|
||||
%(root)s/images.txt:9: WARNING: image file not readable: foo.png
|
||||
%(root)s/images.txt:23: WARNING: nonlocal image URI found: \
|
||||
http://www.python.org/logo.png
|
||||
|
||||
Reference in New Issue
Block a user