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

fix trailing space and long line

Browse Source
This commit is contained in:
Takayuki Shimizukawa 2014-10-09 23:53:33 +09:00
parent 95ada28440
commit da651089e7
12 changed files with 75 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
Makefile
View File

@ -7,7 +7,22 @@ DONT_CHECK = -i build -i dist -i sphinx/style/jquery.js \
-i sphinx/pycode/pgen2 -i sphinx/util/smartypants.py \
-i .ropeproject -i doc/_build -i tests/path.py \
-i tests/coverage.py -i env -i utils/convert.py \
-i sphinx/search/ja.py \
-i sphinx/search/da.py \
-i sphinx/search/de.py \
-i sphinx/search/en.py \
-i sphinx/search/es.py \
-i sphinx/search/fi.py \
-i sphinx/search/fr.py \
-i sphinx/search/hu.py \
-i sphinx/search/it.py \
-i sphinx/search/ja.py \
-i sphinx/search/nl.py \
-i sphinx/search/no.py \
-i sphinx/search/pt.py \
-i sphinx/search/ro.py \
-i sphinx/search/ru.py \
-i sphinx/search/sv.py \
-i sphinx/search/tr.py \
-i utils/reindent3.py -i utils/check_sources3.py -i .tox
all: clean-pyc clean-backupfiles check test

2
doc/domains.rst
View File

@ -526,7 +526,7 @@ The following directives are available. All declarations can start with a visibi
.. rst:directive:: .. cpp:class:: class speicifer
Describe a class/struct, possibly with specification of inheritance, e.g.,::
.. cpp:class:: SomeName::SomeClass : public MyBase, MyOtherBase
.. rst:directive:: .. cpp:function:: (member-)function prototype

2
doc/extdev/appapi.rst
View File

@ -83,7 +83,7 @@ package.
Register an event called *name*. This is needed to be able to emit it.
.. method:: Sphinx.set_translator(name, translator_class)
Register or override a Docutils translator class. This is used to register
a custom output translator or to replace a builtin translator.
This allows extensions to use custom translator and define custom

6
sphinx/writers/texinfo.py
View File

@ -1103,14 +1103,16 @@ class TexinfoTranslator(nodes.NodeVisitor):
def visit_caption(self, node):
if (isinstance(node.parent, nodes.figure) or
(isinstance(node.parent, nodes.container) and node.parent.get('literal_block'))):
(isinstance(node.parent, nodes.container) and
node.parent.get('literal_block'))):
self.body.append('\n@caption{')
else:
self.builder.warn('caption not inside a figure.',
(self.curfilestack[-1], node.line))
def depart_caption(self, node):
if (isinstance(node.parent, nodes.figure) or
(isinstance(node.parent, nodes.container) and node.parent.get('literal_block'))):
(isinstance(node.parent, nodes.container) and
node.parent.get('literal_block'))):
self.body.append('}\n')
def visit_image(self, node):

2
tests/roots/test-autosummary/contents.rst
View File

@ -2,6 +2,6 @@
.. autosummary::
:nosignatures:
:toctree:
dummy_module
sphinx

2
tests/roots/test-ext-viewcode/objects.rst
View File

@ -46,7 +46,7 @@ Referring to :func:`nothing <>`.
.. object:: long(parameter, \
list)
another one
another one
.. class:: TimeInt

3
tests/test_api_translator.py
View File

@ -58,7 +58,8 @@ def test_html_with_set_translator_for_html_(app, status, warning):
@with_app('html', testroot='api-set-translator',
confoverrides={'html_translator_class': 'ext.ExtHTMLTranslator'})
def test_html_with_set_translator_for_html_and_html_translator_class(app, status, warning):
def test_html_with_set_translator_for_html_and_html_translator_class(
app, status, warning):
# use set_translator() and html_translator_class.
# set_translator() is given priority over html_translator_clas.
translator_class = app.builder.translator_class

12
tests/test_autodoc.py
View File

@ -434,21 +434,25 @@ def test_docstring_property_processing():
return results, docstrings
directive.env.config.autodoc_docstring_signature = False
results, docstrings = genarate_docstring('attribute', 'test_autodoc.DocstringSig.prop1')
results, docstrings = \
genarate_docstring('attribute', 'test_autodoc.DocstringSig.prop1')
assert '.. py:attribute:: DocstringSig.prop1' in results
assert 'First line of docstring' in docstrings
assert 'DocstringSig.prop1(self)' in docstrings
results, docstrings = genarate_docstring('attribute', 'test_autodoc.DocstringSig.prop2')
results, docstrings = \
genarate_docstring('attribute', 'test_autodoc.DocstringSig.prop2')
assert '.. py:attribute:: DocstringSig.prop2' in results
assert 'First line of docstring' in docstrings
assert 'Second line of docstring' in docstrings
directive.env.config.autodoc_docstring_signature = True
results, docstrings = genarate_docstring('attribute', 'test_autodoc.DocstringSig.prop1')
results, docstrings = \
genarate_docstring('attribute', 'test_autodoc.DocstringSig.prop1')
assert '.. py:attribute:: DocstringSig.prop1' in results
assert 'First line of docstring' in docstrings
assert 'DocstringSig.prop1(self)' not in docstrings
results, docstrings = genarate_docstring('attribute', 'test_autodoc.DocstringSig.prop2')
results, docstrings = \
genarate_docstring('attribute', 'test_autodoc.DocstringSig.prop2')
assert '.. py:attribute:: DocstringSig.prop2' in results
assert 'First line of docstring' in docstrings
assert 'Second line of docstring' in docstrings

16
tests/test_build.py
View File

@ -76,13 +76,21 @@ def test_build_all():
def test_circular_toctree(app, status, warning):
app.builder.build_all()
warnings = warning.getvalue()
assert 'circular toctree references detected, ignoring: sub <- contents <- sub' in warnings
assert 'circular toctree references detected, ignoring: contents <- sub <- contents' in warnings
assert (
'circular toctree references detected, ignoring: '
'sub <- contents <- sub') in warnings
assert (
'circular toctree references detected, ignoring: '
'contents <- sub <- contents') in warnings
@with_app(buildername='text', testroot='numbered-circular')
def test_numbered_circular_toctree(app, status, warning):
app.builder.build_all()
warnings = warning.getvalue()
assert 'circular toctree references detected, ignoring: sub <- contents <- sub' in warnings
assert 'circular toctree references detected, ignoring: contents <- sub <- contents' in warnings
assert (
'circular toctree references detected, ignoring: '
'sub <- contents <- sub') in warnings
assert (
'circular toctree references detected, ignoring: '
'contents <- sub <- contents') in warnings

5
tests/test_build_gettext.py
View File

@ -66,8 +66,9 @@ def test_all(app, status, warning):
print(stderr)
assert False, 'msgfmt exited with return code %s' % \
p.returncode
yield assert_true, (app.outdir / 'en' / 'LC_MESSAGES' / 'test_root.mo').isfile(), \
'msgfmt failed'
yield (assert_true,
(app.outdir / 'en' / 'LC_MESSAGES' / 'test_root.mo').isfile(),
'msgfmt failed')
finally:
os.chdir(cwd)

3
tests/test_build_html.py
View File

@ -141,7 +141,8 @@ HTML_XPATH = {
(".//a[@href='http://www.python.org/dev/peps/pep-0008']"
"[@class='pep reference external']/strong", 'PEP 8'),
(".//a[@href='http://www.python.org/dev/peps/pep-0008']"
"[@class='pep reference external']/strong", 'Python Enhancement Proposal #8'),
"[@class='pep reference external']/strong",
'Python Enhancement Proposal #8'),
(".//a[@href='http://tools.ietf.org/html/rfc1.html']"
"[@class='rfc reference external']/strong", 'RFC 1'),
(".//a[@href='http://tools.ietf.org/html/rfc1.html']"

35
tests/test_domain_cpp.py
View File

@ -27,7 +27,8 @@ def parse(name, string):
def check(name, input, output=None):
# first a simple check of the AST
if output == None: output = input
if output is None:
output = input
ast = parse(name, input)
res = text_type(ast)
if res != output:
@ -36,7 +37,8 @@ def check(name, input, output=None):
print("Expected: ", output)
raise DefinitionError("")
ast.describe_signature([], 'lastIsName', None)
ast.prefixedName = ast.name # otherwise the get_id fails, it would be set in handle_signarue
ast.prefixedName = ast.name # otherwise the get_id fails, it would be set
# in handle_signarue
ast.get_id()
#print ".. %s:: %s" % (name, input)
@ -49,7 +51,7 @@ def test_type_definitions():
check("type", "bool *volatile const b")
check("type", "bool *volatile const *b")
check("type", "bool &b")
check("type", "bool b[]")
check("type", "bool b[]")
check("type", "std::pair<int, int> coord")
check("type", "long long int foo")
check("type", 'std::vector<std::pair<std::string, long long>> module::blah')
@ -57,12 +59,20 @@ def test_type_definitions():
check("type", "std::function<R(A1, A2, A3)> F")
check("type", "std::function<R(A1, A2, A3, As...)> F")
check("type", "MyContainer::const_iterator")
check("type", "public MyContainer::const_iterator", "MyContainer::const_iterator")
check('member', ' const std::string & name = 42', 'const std::string &name = 42')
check("type",
"public MyContainer::const_iterator",
"MyContainer::const_iterator")
check('member',
' const std::string & name = 42',
'const std::string &name = 42')
check('member', ' const std::string & name', 'const std::string &name')
check('member', ' const std::string & name [ n ]', 'const std::string &name[n]')
check('member', 'const std::vector< unsigned int, long> &name', 'const std::vector<unsigned int, long> &name')
check('member',
' const std::string & name [ n ]',
'const std::string &name[n]')
check('member',
'const std::vector< unsigned int, long> &name',
'const std::vector<unsigned int, long> &name')
check('member', 'module::myclass foo[n]')
check('function', 'operator bool() const')
@ -76,8 +86,10 @@ def test_type_definitions():
check('function', 'int foo(const unsigned int j)')
check('function', 'int foo(const int *const ptr)')
check('function', 'module::myclass::operator std::vector<std::string>()')
check('function', 'void operator()(const boost::array<VertexID, 2> &v) const')
check('function', 'void operator()(const boost::array<VertexID, 2, "foo, bar"> &v) const')
check('function',
'void operator()(const boost::array<VertexID, 2> &v) const')
check('function',
'void operator()(const boost::array<VertexID, 2, "foo, bar"> &v) const')
check('function', 'MyClass::MyClass(MyClass::MyClass&&)')
check('function', 'constexpr int get_value()')
check('function', 'static constexpr int get_value()')
@ -101,7 +113,8 @@ def test_type_definitions():
x = 'std::vector<std::pair<std::string, int>> &module::test(register ' \
'foo, bar[n], std::string baz = "foobar, blah, bleh") const = 0'
check('function', x)
check('function', 'int foo(Foo f = Foo(double(), std::make_pair(int(2), double(3.4))))')
check('function',
'int foo(Foo f = Foo(double(), std::make_pair(int(2), double(3.4))))')
check('function', 'int foo(A a = x(a))')
raises(DefinitionError, parse, 'function', 'int foo(B b=x(a)')
raises(DefinitionError, parse, 'function', 'int foo)C c=x(a))')