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

Satisfy "make check".

Browse Source
This commit is contained in:
Georg Brandl 2011-10-09 23:09:57 +02:00
parent 356b1ab8d3
commit 9a4a3c9afa
8 changed files with 22 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/ext/autosummary.rst
View File

@ -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

2
doc/faq.rst
View File

@ -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.

10
sphinx/apidoc.py
View File

@ -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')

3
sphinx/builders/gettext.py
View File

@ -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)))

3
sphinx/domains/cpp.py
View File

@ -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

11
sphinx/domains/python.py
View File

@ -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,

4
sphinx/quickstart.py
View File

@ -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 '''

3
tests/test_intersphinx.py
View File

@ -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