summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2011-10-09 23:09:57 +0200
committerGeorg Brandl <georg@python.org>2011-10-09 23:09:57 +0200
commitf67f7844aa0fd24504db04e56282b8506bfbfb68 (patch)
treea22fe7ebe1e7364ee1582f543a2e1abb04198817
parent07c872d8e80e1998a696b4975db9a61451a53c5c (diff)
downloadsphinx-f67f7844aa0fd24504db04e56282b8506bfbfb68.tar.gz
Satisfy "make check".
-rw-r--r--doc/ext/autosummary.rst2
-rw-r--r--doc/faq.rst2
-rw-r--r--sphinx/apidoc.py10
-rw-r--r--sphinx/builders/gettext.py3
-rw-r--r--sphinx/domains/cpp.py3
-rw-r--r--sphinx/domains/python.py11
-rw-r--r--sphinx/quickstart.py4
-rw-r--r--tests/test_intersphinx.py3
8 files changed, 22 insertions, 16 deletions
diff --git a/doc/ext/autosummary.rst b/doc/ext/autosummary.rst
index 878a3c2c..e3de1835 100644
--- a/doc/ext/autosummary.rst
+++ b/doc/ext/autosummary.rst
@@ -29,7 +29,7 @@ The :mod:`sphinx.ext.autosummary` extension does this in two parts:
.. rst:directive:: autosummary
Insert a table that contains links to documented items, and a short summary
- blurb (the first sentence of the docstring) for each of them.
+ blurb (the first sentence of the docstring) for each of them.
The :rst:dir:`autosummary` directive can also optionally serve as a
:rst:dir:`toctree` entry for the included items. Optionally, stub
diff --git a/doc/faq.rst b/doc/faq.rst
index 965a1986..bf2327d7 100644
--- a/doc/faq.rst
+++ b/doc/faq.rst
@@ -45,7 +45,7 @@ Using Sphinx with...
Read the Docs
http://readthedocs.org is a documentation hosting service based around Sphinx.
They will host sphinx documentation, along with supporting a number of other
- features including version support, PDF generation, and more. The `Getting
+ features including version support, PDF generation, and more. The `Getting
Started <http://read-the-docs.readthedocs.org/en/latest/getting_started.html>`_
guide is a good place to start.
diff --git a/sphinx/apidoc.py b/sphinx/apidoc.py
index 24c56fbf..7e7f341f 100644
--- a/sphinx/apidoc.py
+++ b/sphinx/apidoc.py
@@ -8,9 +8,9 @@
creates a modules index (named modules.<suffix>).
This is derived from the "sphinx-autopackage" script, which is:
- Copyright 2008 Société des arts technologiques (SAT), http://www.sat.qc.ca/.
+ Copyright 2008 Société des arts technologiques (SAT), http://www.sat.qc.ca/
- :copyright: 2007-2011 by the Sphinx team, see AUTHORS.
+ :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
import os
@@ -172,7 +172,8 @@ def recurse_tree(rootpath, excludes, opts):
if is_pkg:
# we are in a package with something to document
- if subs or len(py_files) > 1 or not shall_skip(path.join(root, INITPY)):
+ if subs or len(py_files) > 1 or not \
+ shall_skip(path.join(root, INITPY)):
subpackage = root[len(rootpath):].lstrip(path.sep).\
replace(path.sep, '.')
create_package_file(root, root_package, subpackage,
@@ -251,7 +252,8 @@ Note: By default this script will not overwrite already created files.""")
help='Generate a full project with sphinx-quickstart')
parser.add_option('-H', '--doc-project', action='store', dest='header',
help='Project name (default: root module name)')
- parser.add_option('-A', '--doc-author', action='store', dest='author', type='str',
+ parser.add_option('-A', '--doc-author', action='store', dest='author',
+ type='str',
help='Project author(s), used when --full is given')
parser.add_option('-V', '--doc-version', action='store', dest='version',
help='Project version, used when --full is given')
diff --git a/sphinx/builders/gettext.py b/sphinx/builders/gettext.py
index 80df09a5..a5f71a5f 100644
--- a/sphinx/builders/gettext.py
+++ b/sphinx/builders/gettext.py
@@ -100,7 +100,8 @@ class MessageCatalogBuilder(I18nBuilder):
)
for textdomain, catalog in self.status_iterator(
self.catalogs.iteritems(), "writing message catalogs... ",
- lambda (textdomain, _):darkgreen(textdomain), len(self.catalogs)):
+ lambda (textdomain, _): darkgreen(textdomain),
+ len(self.catalogs)):
# noop if config.gettext_compact is set
ensuredir(path.join(self.outdir, path.dirname(textdomain)))
diff --git a/sphinx/domains/cpp.py b/sphinx/domains/cpp.py
index 46bb7353..acb8ba09 100644
--- a/sphinx/domains/cpp.py
+++ b/sphinx/domains/cpp.py
@@ -1028,7 +1028,8 @@ class CPPClassObject(CPPObject):
signode += nodes.Text(' : ')
for base in cls.bases:
self.attach_modifiers(signode, base, 'private')
- signode += nodes.emphasis(unicode(base.name), unicode(base.name))
+ signode += nodes.emphasis(unicode(base.name),
+ unicode(base.name))
signode += nodes.Text(', ')
signode.pop() # remove the trailing comma
diff --git a/sphinx/domains/python.py b/sphinx/domains/python.py
index 98d93545..779b071a 100644
--- a/sphinx/domains/python.py
+++ b/sphinx/domains/python.py
@@ -422,13 +422,14 @@ class PyModule(Directive):
env.domaindata['py']['modules'][modname] = \
(env.docname, self.options.get('synopsis', ''),
self.options.get('platform', ''), 'deprecated' in self.options)
- # make a duplicate entry in 'objects' to facilitate searching for the
- # module in PythonDomain.find_obj()
+ # make a duplicate entry in 'objects' to facilitate searching for
+ # the module in PythonDomain.find_obj()
env.domaindata['py']['objects'][modname] = (env.docname, 'module')
- targetnode = nodes.target('', '', ids=['module-' + modname], ismod=True)
+ targetnode = nodes.target('', '', ids=['module-' + modname],
+ ismod=True)
self.state.document.note_explicit_target(targetnode)
- # the platform and synopsis aren't printed; in fact, they are only used
- # in the modindex currently
+ # the platform and synopsis aren't printed; in fact, they are only
+ # used in the modindex currently
ret.append(targetnode)
indextext = _('%s (module)') % modname
inode = addnodes.index(entries=[('single', indextext,
diff --git a/sphinx/quickstart.py b/sphinx/quickstart.py
index ecb46040..88be5cee 100644
--- a/sphinx/quickstart.py
+++ b/sphinx/quickstart.py
@@ -934,8 +934,8 @@ pngmath has been deselected.'''
do_prompt(d, 'ext_ifconfig', 'ifconfig: conditional inclusion of '
'content based on config values (y/N)', 'n', boolean)
if 'ext_viewcode' not in d:
- do_prompt(d, 'ext_viewcode', 'viewcode: include links to the source code '
- 'of documented Python objects (y/N)', 'n', boolean)
+ do_prompt(d, 'ext_viewcode', 'viewcode: include links to the source '
+ 'code of documented Python objects (y/N)', 'n', boolean)
if 'makefile' not in d:
print '''
diff --git a/tests/test_intersphinx.py b/tests/test_intersphinx.py
index 563750f6..e1f4e827 100644
--- a/tests/test_intersphinx.py
+++ b/tests/test_intersphinx.py
@@ -167,7 +167,8 @@ def test_load_mappings_warnings(tempdir, app):
'http://docs.python.org/': inv_file,
'py3k': ('http://docs.python.org/py3k/', inv_file),
'repoze.workflow': ('http://docs.repoze.org/workflow/', inv_file),
- 'django-taggit': ('http://django-taggit.readthedocs.org/en/latest/', inv_file)
+ 'django-taggit': ('http://django-taggit.readthedocs.org/en/latest/',
+ inv_file)
}
app.config.intersphinx_cache_limit = 0