From 567d52f199d74a9ec84c491b5d7c9a4555912db0 Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Sat, 3 Jan 2015 21:36:32 +0100 Subject: [PATCH 01/40] all: update copyright --- doc/_themes/sphinx13/layout.html | 2 +- doc/_themes/sphinx13/static/sphinx13.css | 2 +- doc/conf.py | 2 +- sphinx-apidoc.py | 2 +- sphinx-autogen.py | 2 +- sphinx-build.py | 2 +- sphinx-quickstart.py | 2 +- sphinx/__init__.py | 2 +- sphinx/addnodes.py | 2 +- sphinx/apidoc.py | 2 +- sphinx/application.py | 2 +- sphinx/builders/__init__.py | 2 +- sphinx/builders/changes.py | 2 +- sphinx/builders/devhelp.py | 2 +- sphinx/builders/epub.py | 2 +- sphinx/builders/gettext.py | 2 +- sphinx/builders/html.py | 2 +- sphinx/builders/htmlhelp.py | 2 +- sphinx/builders/latex.py | 2 +- sphinx/builders/linkcheck.py | 2 +- sphinx/builders/manpage.py | 2 +- sphinx/builders/qthelp.py | 2 +- sphinx/builders/texinfo.py | 2 +- sphinx/builders/text.py | 2 +- sphinx/builders/websupport.py | 2 +- sphinx/builders/xml.py | 2 +- sphinx/cmdline.py | 2 +- sphinx/config.py | 2 +- sphinx/directives/__init__.py | 2 +- sphinx/directives/code.py | 2 +- sphinx/directives/other.py | 2 +- sphinx/domains/__init__.py | 2 +- sphinx/domains/c.py | 2 +- sphinx/domains/cpp.py | 2 +- sphinx/domains/javascript.py | 2 +- sphinx/domains/python.py | 2 +- sphinx/domains/rst.py | 2 +- sphinx/domains/std.py | 2 +- sphinx/environment.py | 2 +- sphinx/errors.py | 2 +- sphinx/ext/__init__.py | 2 +- sphinx/ext/autodoc.py | 2 +- sphinx/ext/autosummary/__init__.py | 2 +- sphinx/ext/autosummary/generate.py | 2 +- sphinx/ext/coverage.py | 2 +- sphinx/ext/doctest.py | 2 +- sphinx/ext/extlinks.py | 2 +- sphinx/ext/graphviz.py | 2 +- sphinx/ext/ifconfig.py | 2 +- sphinx/ext/inheritance_diagram.py | 2 +- sphinx/ext/intersphinx.py | 2 +- sphinx/ext/jsmath.py | 2 +- sphinx/ext/linkcode.py | 2 +- sphinx/ext/mathbase.py | 2 +- sphinx/ext/mathjax.py | 2 +- sphinx/ext/pngmath.py | 2 +- sphinx/ext/todo.py | 2 +- sphinx/ext/viewcode.py | 2 +- sphinx/highlighting.py | 2 +- sphinx/jinja2glue.py | 2 +- sphinx/locale/__init__.py | 2 +- sphinx/make_mode.py | 2 +- sphinx/pycode/__init__.py | 2 +- sphinx/pycode/nodes.py | 2 +- sphinx/pygments_styles.py | 2 +- sphinx/quickstart.py | 2 +- sphinx/roles.py | 2 +- sphinx/search/__init__.py | 2 +- sphinx/search/en.py | 2 +- sphinx/search/ja.py | 2 +- sphinx/setup_command.py | 2 +- sphinx/themes/agogo/layout.html | 2 +- sphinx/themes/agogo/static/agogo.css_t | 2 +- sphinx/themes/basic/defindex.html | 2 +- sphinx/themes/basic/domainindex.html | 2 +- sphinx/themes/basic/genindex-single.html | 2 +- sphinx/themes/basic/genindex-split.html | 2 +- sphinx/themes/basic/genindex.html | 2 +- sphinx/themes/basic/globaltoc.html | 2 +- sphinx/themes/basic/layout.html | 2 +- sphinx/themes/basic/localtoc.html | 2 +- sphinx/themes/basic/page.html | 2 +- sphinx/themes/basic/relations.html | 2 +- sphinx/themes/basic/search.html | 2 +- sphinx/themes/basic/searchbox.html | 2 +- sphinx/themes/basic/searchresults.html | 2 +- sphinx/themes/basic/sourcelink.html | 2 +- sphinx/themes/basic/static/basic.css_t | 2 +- sphinx/themes/basic/static/doctools.js | 2 +- sphinx/themes/basic/static/searchtools.js_t | 2 +- sphinx/themes/basic/static/websupport.js | 2 +- sphinx/themes/default/layout.html | 2 +- sphinx/themes/default/static/default.css_t | 2 +- sphinx/themes/default/static/sidebar.js_t | 2 +- sphinx/themes/epub/epub-cover.html | 2 +- sphinx/themes/epub/layout.html | 2 +- sphinx/themes/epub/static/epub.css | 4 ++-- sphinx/themes/haiku/layout.html | 2 +- sphinx/themes/haiku/static/haiku.css_t | 2 +- sphinx/themes/nature/static/nature.css_t | 2 +- sphinx/themes/pyramid/static/epub.css | 2 +- sphinx/themes/pyramid/static/pyramid.css_t | 2 +- sphinx/themes/scrolls/layout.html | 2 +- sphinx/themes/scrolls/static/scrolls.css_t | 2 +- sphinx/themes/sphinxdoc/layout.html | 2 +- sphinx/themes/sphinxdoc/static/sphinxdoc.css_t | 2 +- sphinx/themes/traditional/static/traditional.css_t | 2 +- sphinx/theming.py | 2 +- sphinx/transforms.py | 2 +- sphinx/util/__init__.py | 2 +- sphinx/util/compat.py | 2 +- sphinx/util/console.py | 2 +- sphinx/util/docfields.py | 2 +- sphinx/util/docstrings.py | 2 +- sphinx/util/inspect.py | 2 +- sphinx/util/jsdump.py | 2 +- sphinx/util/jsonimpl.py | 2 +- sphinx/util/matching.py | 2 +- sphinx/util/nodes.py | 2 +- sphinx/util/osutil.py | 2 +- sphinx/util/png.py | 2 +- sphinx/util/pycompat.py | 2 +- sphinx/util/tags.py | 2 +- sphinx/util/texescape.py | 2 +- sphinx/util/websupport.py | 2 +- sphinx/versioning.py | 2 +- sphinx/websupport/__init__.py | 2 +- sphinx/websupport/errors.py | 2 +- sphinx/websupport/search/__init__.py | 2 +- sphinx/websupport/search/nullsearch.py | 2 +- sphinx/websupport/search/whooshsearch.py | 2 +- sphinx/websupport/search/xapiansearch.py | 2 +- sphinx/websupport/storage/__init__.py | 2 +- sphinx/websupport/storage/differ.py | 2 +- sphinx/websupport/storage/sqlalchemy_db.py | 2 +- sphinx/websupport/storage/sqlalchemystorage.py | 2 +- sphinx/writers/__init__.py | 2 +- sphinx/writers/html.py | 2 +- sphinx/writers/latex.py | 2 +- sphinx/writers/manpage.py | 2 +- sphinx/writers/texinfo.py | 2 +- sphinx/writers/text.py | 2 +- sphinx/writers/websupport.py | 2 +- sphinx/writers/xml.py | 2 +- tests/path.py | 2 +- tests/run.py | 2 +- tests/test_application.py | 2 +- tests/test_autodoc.py | 2 +- tests/test_autosummary.py | 2 +- tests/test_build.py | 2 +- tests/test_build_gettext.py | 2 +- tests/test_build_html.py | 2 +- tests/test_build_latex.py | 2 +- tests/test_build_texinfo.py | 2 +- tests/test_build_text.py | 2 +- tests/test_config.py | 2 +- tests/test_coverage.py | 2 +- tests/test_cpp_domain.py | 2 +- tests/test_doctest.py | 2 +- tests/test_docutilsconf.py | 2 +- tests/test_env.py | 2 +- tests/test_footnote.py | 2 +- tests/test_highlighting.py | 2 +- tests/test_i18n.py | 2 +- tests/test_intersphinx.py | 2 +- tests/test_intl.py | 2 +- tests/test_linkcode.py | 2 +- tests/test_markup.py | 2 +- tests/test_metadata.py | 2 +- tests/test_only_directive.py | 2 +- tests/test_py_domain.py | 2 +- tests/test_quickstart.py | 2 +- tests/test_rst_domain.py | 2 +- tests/test_search.py | 2 +- tests/test_searchadapters.py | 2 +- tests/test_setup_command.py | 2 +- tests/test_templating.py | 2 +- tests/test_theming.py | 2 +- tests/test_util_nodes.py | 2 +- tests/test_versioning.py | 2 +- tests/test_websupport.py | 2 +- tests/util.py | 2 +- utils/check_sources.py | 2 +- utils/convert.py | 2 +- 184 files changed, 185 insertions(+), 185 deletions(-) diff --git a/doc/_themes/sphinx13/layout.html b/doc/_themes/sphinx13/layout.html index 57378c1ab..0e6294cc4 100644 --- a/doc/_themes/sphinx13/layout.html +++ b/doc/_themes/sphinx13/layout.html @@ -4,7 +4,7 @@ Sphinx layout template for the sphinxdoc theme. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. #} {%- extends "basic/layout.html" %} diff --git a/doc/_themes/sphinx13/static/sphinx13.css b/doc/_themes/sphinx13/static/sphinx13.css index 0b31c6b15..222432d5c 100644 --- a/doc/_themes/sphinx13/static/sphinx13.css +++ b/doc/_themes/sphinx13/static/sphinx13.css @@ -4,7 +4,7 @@ * * Sphinx stylesheet -- sphinx13 theme. * - * :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ diff --git a/doc/conf.py b/doc/conf.py index 9640e2edb..545be5a88 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -13,7 +13,7 @@ templates_path = ['_templates'] exclude_patterns = ['_build'] project = 'Sphinx' -copyright = '2007-2014, Georg Brandl and the Sphinx team' +copyright = '2007-2015, Georg Brandl and the Sphinx team' version = sphinx.__released__ release = version show_authors = True diff --git a/sphinx-apidoc.py b/sphinx-apidoc.py index 02bf8b888..7752fc0d1 100755 --- a/sphinx-apidoc.py +++ b/sphinx-apidoc.py @@ -4,7 +4,7 @@ Sphinx - Python documentation toolchain ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx-autogen.py b/sphinx-autogen.py index ba3f0f454..ea085573f 100755 --- a/sphinx-autogen.py +++ b/sphinx-autogen.py @@ -4,7 +4,7 @@ Sphinx - Python documentation toolchain ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx-build.py b/sphinx-build.py index 8dd21a7ed..7c539d643 100755 --- a/sphinx-build.py +++ b/sphinx-build.py @@ -4,7 +4,7 @@ Sphinx - Python documentation toolchain ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx-quickstart.py b/sphinx-quickstart.py index 5d2b01df2..89ad8f891 100755 --- a/sphinx-quickstart.py +++ b/sphinx-quickstart.py @@ -4,7 +4,7 @@ Sphinx - Python documentation toolchain ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/__init__.py b/sphinx/__init__.py index 49bbc284c..ec9ed18d7 100644 --- a/sphinx/__init__.py +++ b/sphinx/__init__.py @@ -5,7 +5,7 @@ The Sphinx documentation toolchain. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/addnodes.py b/sphinx/addnodes.py index 2806a059c..4701866e8 100644 --- a/sphinx/addnodes.py +++ b/sphinx/addnodes.py @@ -5,7 +5,7 @@ Additional docutils nodes. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/apidoc.py b/sphinx/apidoc.py index 755ea5efe..eefe58e78 100644 --- a/sphinx/apidoc.py +++ b/sphinx/apidoc.py @@ -11,7 +11,7 @@ Copyright 2008 Société des arts technologiques (SAT), http://www.sat.qc.ca/ - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ import os diff --git a/sphinx/application.py b/sphinx/application.py index 2704df23f..8012d2409 100644 --- a/sphinx/application.py +++ b/sphinx/application.py @@ -7,7 +7,7 @@ Gracefully adapted from the TextPress system by Armin. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/builders/__init__.py b/sphinx/builders/__init__.py index c02ecb53f..d2c883d78 100644 --- a/sphinx/builders/__init__.py +++ b/sphinx/builders/__init__.py @@ -5,7 +5,7 @@ Builder superclass for all builders. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/builders/changes.py b/sphinx/builders/changes.py index c9317af22..b729ac6d2 100644 --- a/sphinx/builders/changes.py +++ b/sphinx/builders/changes.py @@ -5,7 +5,7 @@ Changelog builder. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/builders/devhelp.py b/sphinx/builders/devhelp.py index 61482fd08..bc7916667 100644 --- a/sphinx/builders/devhelp.py +++ b/sphinx/builders/devhelp.py @@ -7,7 +7,7 @@ .. _Devhelp: http://live.gnome.org/devhelp - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ from __future__ import absolute_import diff --git a/sphinx/builders/epub.py b/sphinx/builders/epub.py index a73679c01..bb9404474 100644 --- a/sphinx/builders/epub.py +++ b/sphinx/builders/epub.py @@ -6,7 +6,7 @@ Build epub files. Originally derived from qthelp.py. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/builders/gettext.py b/sphinx/builders/gettext.py index 250bef8cf..ae539d002 100644 --- a/sphinx/builders/gettext.py +++ b/sphinx/builders/gettext.py @@ -5,7 +5,7 @@ The MessageCatalogBuilder class. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/builders/html.py b/sphinx/builders/html.py index 9c039e3aa..36cd965c9 100644 --- a/sphinx/builders/html.py +++ b/sphinx/builders/html.py @@ -5,7 +5,7 @@ Several HTML builders. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/builders/htmlhelp.py b/sphinx/builders/htmlhelp.py index 77fcd4386..efb481ab7 100644 --- a/sphinx/builders/htmlhelp.py +++ b/sphinx/builders/htmlhelp.py @@ -6,7 +6,7 @@ Build HTML help support files. Parts adapted from Python's Doc/tools/prechm.py. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/builders/latex.py b/sphinx/builders/latex.py index f54533057..d55345bcd 100644 --- a/sphinx/builders/latex.py +++ b/sphinx/builders/latex.py @@ -5,7 +5,7 @@ LaTeX builder. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/builders/linkcheck.py b/sphinx/builders/linkcheck.py index f0cb3c9a7..6e308dc3e 100644 --- a/sphinx/builders/linkcheck.py +++ b/sphinx/builders/linkcheck.py @@ -5,7 +5,7 @@ The CheckExternalLinksBuilder class. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/builders/manpage.py b/sphinx/builders/manpage.py index 4de82a751..848121bd0 100644 --- a/sphinx/builders/manpage.py +++ b/sphinx/builders/manpage.py @@ -5,7 +5,7 @@ Manual pages builder. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/builders/qthelp.py b/sphinx/builders/qthelp.py index 1d4628413..37e6b24c3 100644 --- a/sphinx/builders/qthelp.py +++ b/sphinx/builders/qthelp.py @@ -5,7 +5,7 @@ Build input files for the Qt collection generator. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/builders/texinfo.py b/sphinx/builders/texinfo.py index 39499e666..64f6b6521 100644 --- a/sphinx/builders/texinfo.py +++ b/sphinx/builders/texinfo.py @@ -5,7 +5,7 @@ Texinfo builder. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/builders/text.py b/sphinx/builders/text.py index 0aeeb5f44..126b854f4 100644 --- a/sphinx/builders/text.py +++ b/sphinx/builders/text.py @@ -5,7 +5,7 @@ Plain-text Sphinx builder. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/builders/websupport.py b/sphinx/builders/websupport.py index 6cf981023..8663dd3ca 100644 --- a/sphinx/builders/websupport.py +++ b/sphinx/builders/websupport.py @@ -5,7 +5,7 @@ Builder for the web support package. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/builders/xml.py b/sphinx/builders/xml.py index 9a9aec96f..c9b79d1f9 100644 --- a/sphinx/builders/xml.py +++ b/sphinx/builders/xml.py @@ -5,7 +5,7 @@ Docutils-native XML and pseudo-XML builders. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/cmdline.py b/sphinx/cmdline.py index 69817e444..b30b2e7a6 100644 --- a/sphinx/cmdline.py +++ b/sphinx/cmdline.py @@ -5,7 +5,7 @@ sphinx-build command-line handling. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/config.py b/sphinx/config.py index 69ba7cfe1..830a50dbd 100644 --- a/sphinx/config.py +++ b/sphinx/config.py @@ -5,7 +5,7 @@ Build configuration file handling. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ from __future__ import with_statement diff --git a/sphinx/directives/__init__.py b/sphinx/directives/__init__.py index 250a013e9..8fd54063f 100644 --- a/sphinx/directives/__init__.py +++ b/sphinx/directives/__init__.py @@ -5,7 +5,7 @@ Handlers for additional ReST directives. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/directives/code.py b/sphinx/directives/code.py index 9bfac5a64..f8812cbcf 100644 --- a/sphinx/directives/code.py +++ b/sphinx/directives/code.py @@ -3,7 +3,7 @@ sphinx.directives.code ~~~~~~~~~~~~~~~~~~~~~~ - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/directives/other.py b/sphinx/directives/other.py index d28c00fb5..2e2c7aff6 100644 --- a/sphinx/directives/other.py +++ b/sphinx/directives/other.py @@ -3,7 +3,7 @@ sphinx.directives.other ~~~~~~~~~~~~~~~~~~~~~~~ - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/domains/__init__.py b/sphinx/domains/__init__.py index 200fd5158..aeb9a3db3 100644 --- a/sphinx/domains/__init__.py +++ b/sphinx/domains/__init__.py @@ -6,7 +6,7 @@ Support for domains, which are groupings of description directives and roles describing e.g. constructs of one programming language. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/domains/c.py b/sphinx/domains/c.py index fb38cfe8f..5201bcbec 100644 --- a/sphinx/domains/c.py +++ b/sphinx/domains/c.py @@ -5,7 +5,7 @@ The C language domain. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/domains/cpp.py b/sphinx/domains/cpp.py index cb64a60dd..e468e8514 100644 --- a/sphinx/domains/cpp.py +++ b/sphinx/domains/cpp.py @@ -5,7 +5,7 @@ The C++ language domain. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/domains/javascript.py b/sphinx/domains/javascript.py index 9b7777f41..99481a653 100644 --- a/sphinx/domains/javascript.py +++ b/sphinx/domains/javascript.py @@ -5,7 +5,7 @@ The JavaScript domain. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/domains/python.py b/sphinx/domains/python.py index 792cffd8e..efc2e5374 100644 --- a/sphinx/domains/python.py +++ b/sphinx/domains/python.py @@ -5,7 +5,7 @@ The Python domain. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/domains/rst.py b/sphinx/domains/rst.py index c51c85feb..039e3292f 100644 --- a/sphinx/domains/rst.py +++ b/sphinx/domains/rst.py @@ -5,7 +5,7 @@ The reStructuredText domain. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/domains/std.py b/sphinx/domains/std.py index 9a7937aad..85383ea40 100644 --- a/sphinx/domains/std.py +++ b/sphinx/domains/std.py @@ -5,7 +5,7 @@ The standard domain. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/environment.py b/sphinx/environment.py index 6a05f9b10..d83243215 100644 --- a/sphinx/environment.py +++ b/sphinx/environment.py @@ -5,7 +5,7 @@ Global creation environment. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/errors.py b/sphinx/errors.py index 4d737e512..3b4d26477 100644 --- a/sphinx/errors.py +++ b/sphinx/errors.py @@ -6,7 +6,7 @@ Contains SphinxError and a few subclasses (in an extra module to avoid circular import problems). - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/ext/__init__.py b/sphinx/ext/__init__.py index 5a807ba7b..62c6416c3 100644 --- a/sphinx/ext/__init__.py +++ b/sphinx/ext/__init__.py @@ -5,6 +5,6 @@ Contains Sphinx features not activated by default. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/ext/autodoc.py b/sphinx/ext/autodoc.py index 8c4f15936..c47d1ef0f 100644 --- a/sphinx/ext/autodoc.py +++ b/sphinx/ext/autodoc.py @@ -7,7 +7,7 @@ the doctree, thus avoiding duplication between docstrings and documentation for those who like elaborate docstrings. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/ext/autosummary/__init__.py b/sphinx/ext/autosummary/__init__.py index 8798e7f6b..82892fe9d 100644 --- a/sphinx/ext/autosummary/__init__.py +++ b/sphinx/ext/autosummary/__init__.py @@ -49,7 +49,7 @@ resolved to a Python object, and otherwise it becomes simple emphasis. This can be used as the default role to make links 'smart'. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/ext/autosummary/generate.py b/sphinx/ext/autosummary/generate.py index 47ef9868a..9deed4ea4 100644 --- a/sphinx/ext/autosummary/generate.py +++ b/sphinx/ext/autosummary/generate.py @@ -14,7 +14,7 @@ generate: sphinx-autogen -o source/generated source/*.rst - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/ext/coverage.py b/sphinx/ext/coverage.py index 52be1bdba..e9798817b 100644 --- a/sphinx/ext/coverage.py +++ b/sphinx/ext/coverage.py @@ -6,7 +6,7 @@ Check Python modules and C API for coverage. Mostly written by Josip Dzolonga for the Google Highly Open Participation contest. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/ext/doctest.py b/sphinx/ext/doctest.py index 70beb9bfd..f112e670e 100644 --- a/sphinx/ext/doctest.py +++ b/sphinx/ext/doctest.py @@ -6,7 +6,7 @@ Mimic doctest by automatically executing code snippets and checking their results. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/ext/extlinks.py b/sphinx/ext/extlinks.py index 18da573ef..5c46a1355 100644 --- a/sphinx/ext/extlinks.py +++ b/sphinx/ext/extlinks.py @@ -20,7 +20,7 @@ You can also give an explicit caption, e.g. :exmpl:`Foo `. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/ext/graphviz.py b/sphinx/ext/graphviz.py index 028560b14..0289bf84d 100644 --- a/sphinx/ext/graphviz.py +++ b/sphinx/ext/graphviz.py @@ -6,7 +6,7 @@ Allow graphviz-formatted graphs to be included in Sphinx-generated documents inline. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/ext/ifconfig.py b/sphinx/ext/ifconfig.py index 3362e56a0..195783755 100644 --- a/sphinx/ext/ifconfig.py +++ b/sphinx/ext/ifconfig.py @@ -16,7 +16,7 @@ namespace of the project configuration (that is, all variables from ``conf.py`` are available.) - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/ext/inheritance_diagram.py b/sphinx/ext/inheritance_diagram.py index 5b8eab3f9..74246876f 100644 --- a/sphinx/ext/inheritance_diagram.py +++ b/sphinx/ext/inheritance_diagram.py @@ -32,7 +32,7 @@ r""" The graph is inserted as a PNG+image map into HTML and a PDF in LaTeX. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/ext/intersphinx.py b/sphinx/ext/intersphinx.py index c3adf563e..a15f79bb0 100644 --- a/sphinx/ext/intersphinx.py +++ b/sphinx/ext/intersphinx.py @@ -20,7 +20,7 @@ also be specified individually, e.g. if the docs should be buildable without Internet access. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/ext/jsmath.py b/sphinx/ext/jsmath.py index 8907576f5..570bfcf38 100644 --- a/sphinx/ext/jsmath.py +++ b/sphinx/ext/jsmath.py @@ -6,7 +6,7 @@ Set up everything for use of JSMath to display math in HTML via JavaScript. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/ext/linkcode.py b/sphinx/ext/linkcode.py index 77bd9f28a..515a67d82 100644 --- a/sphinx/ext/linkcode.py +++ b/sphinx/ext/linkcode.py @@ -5,7 +5,7 @@ Add external links to module code in Python object descriptions. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/ext/mathbase.py b/sphinx/ext/mathbase.py index 6aaffca87..57a7ec314 100644 --- a/sphinx/ext/mathbase.py +++ b/sphinx/ext/mathbase.py @@ -5,7 +5,7 @@ Set up math support in source files and LaTeX/text output. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/ext/mathjax.py b/sphinx/ext/mathjax.py index ee2786671..7dfebc9f8 100644 --- a/sphinx/ext/mathjax.py +++ b/sphinx/ext/mathjax.py @@ -7,7 +7,7 @@ Sphinx's HTML writer -- requires the MathJax JavaScript library on your webserver/computer. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/ext/pngmath.py b/sphinx/ext/pngmath.py index abac15cd3..877c0e769 100644 --- a/sphinx/ext/pngmath.py +++ b/sphinx/ext/pngmath.py @@ -5,7 +5,7 @@ Render math in HTML via dvipng. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ from __future__ import with_statement diff --git a/sphinx/ext/todo.py b/sphinx/ext/todo.py index 9f521fb49..b4ce4bd04 100644 --- a/sphinx/ext/todo.py +++ b/sphinx/ext/todo.py @@ -8,7 +8,7 @@ all todos of your project and lists them along with a backlink to the original location. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/ext/viewcode.py b/sphinx/ext/viewcode.py index 74a004635..9f6939039 100644 --- a/sphinx/ext/viewcode.py +++ b/sphinx/ext/viewcode.py @@ -5,7 +5,7 @@ Add links to module code in Python object descriptions. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/highlighting.py b/sphinx/highlighting.py index 600a7cf08..d8f6c3967 100644 --- a/sphinx/highlighting.py +++ b/sphinx/highlighting.py @@ -5,7 +5,7 @@ Highlight code blocks using Pygments. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/jinja2glue.py b/sphinx/jinja2glue.py index f4a5a8159..79e6d48ea 100644 --- a/sphinx/jinja2glue.py +++ b/sphinx/jinja2glue.py @@ -5,7 +5,7 @@ Glue code for the jinja2 templating engine. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/locale/__init__.py b/sphinx/locale/__init__.py index b76aab1f7..2c7487d63 100644 --- a/sphinx/locale/__init__.py +++ b/sphinx/locale/__init__.py @@ -5,7 +5,7 @@ Locale utilities. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/make_mode.py b/sphinx/make_mode.py index 45f62b9b1..0a54d0fa2 100644 --- a/sphinx/make_mode.py +++ b/sphinx/make_mode.py @@ -11,7 +11,7 @@ This is in its own module so that importing it is fast. It should not import the main Sphinx modules (like sphinx.applications, sphinx.builders). - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ from __future__ import with_statement diff --git a/sphinx/pycode/__init__.py b/sphinx/pycode/__init__.py index 7a6f59b1a..177836f6a 100644 --- a/sphinx/pycode/__init__.py +++ b/sphinx/pycode/__init__.py @@ -5,7 +5,7 @@ Utilities parsing and analyzing Python code. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/pycode/nodes.py b/sphinx/pycode/nodes.py index 8bba3491b..06e664827 100644 --- a/sphinx/pycode/nodes.py +++ b/sphinx/pycode/nodes.py @@ -5,7 +5,7 @@ Parse tree node implementations. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/pygments_styles.py b/sphinx/pygments_styles.py index a7335e609..a15f2f393 100644 --- a/sphinx/pygments_styles.py +++ b/sphinx/pygments_styles.py @@ -5,7 +5,7 @@ Sphinx theme specific highlighting styles. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/quickstart.py b/sphinx/quickstart.py index dbb01c59b..81a6e039d 100644 --- a/sphinx/quickstart.py +++ b/sphinx/quickstart.py @@ -5,7 +5,7 @@ Quickly setup documentation source to work with Sphinx. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/roles.py b/sphinx/roles.py index c31ec055b..500c4a2ef 100644 --- a/sphinx/roles.py +++ b/sphinx/roles.py @@ -5,7 +5,7 @@ Handlers for additional ReST roles. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/search/__init__.py b/sphinx/search/__init__.py index d57efd9ed..e24da2d08 100644 --- a/sphinx/search/__init__.py +++ b/sphinx/search/__init__.py @@ -5,7 +5,7 @@ Create a full-text search index for offline search. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ from __future__ import with_statement diff --git a/sphinx/search/en.py b/sphinx/search/en.py index 33e817705..67cf83849 100644 --- a/sphinx/search/en.py +++ b/sphinx/search/en.py @@ -5,7 +5,7 @@ English search language: includes the JS porter stemmer. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/search/ja.py b/sphinx/search/ja.py index 1f8398ddd..9ae60e5fb 100644 --- a/sphinx/search/ja.py +++ b/sphinx/search/ja.py @@ -5,7 +5,7 @@ Japanese search language: includes routine to split words. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/setup_command.py b/sphinx/setup_command.py index a487b2a2a..29f107681 100644 --- a/sphinx/setup_command.py +++ b/sphinx/setup_command.py @@ -8,7 +8,7 @@ :author: Sebastian Wiesner :contact: basti.wiesner@gmx.net - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/themes/agogo/layout.html b/sphinx/themes/agogo/layout.html index c6960fb07..1f9bc88f5 100644 --- a/sphinx/themes/agogo/layout.html +++ b/sphinx/themes/agogo/layout.html @@ -5,7 +5,7 @@ Sphinx layout template for the agogo theme, originally written by Andi Albrecht. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. #} {%- extends "basic/layout.html" %} diff --git a/sphinx/themes/agogo/static/agogo.css_t b/sphinx/themes/agogo/static/agogo.css_t index 1ec214709..92d7097ad 100644 --- a/sphinx/themes/agogo/static/agogo.css_t +++ b/sphinx/themes/agogo/static/agogo.css_t @@ -4,7 +4,7 @@ * * Sphinx stylesheet -- agogo theme. * - * :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ diff --git a/sphinx/themes/basic/defindex.html b/sphinx/themes/basic/defindex.html index 9316cfda4..3c1240ebd 100644 --- a/sphinx/themes/basic/defindex.html +++ b/sphinx/themes/basic/defindex.html @@ -4,7 +4,7 @@ Default template for the "index" page. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. #} {%- extends "layout.html" %} diff --git a/sphinx/themes/basic/domainindex.html b/sphinx/themes/basic/domainindex.html index ac5aed9fd..a33bade92 100644 --- a/sphinx/themes/basic/domainindex.html +++ b/sphinx/themes/basic/domainindex.html @@ -4,7 +4,7 @@ Template for domain indices (module index, ...). - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. #} {%- extends "layout.html" %} diff --git a/sphinx/themes/basic/genindex-single.html b/sphinx/themes/basic/genindex-single.html index ec57a7bf0..ddc988381 100644 --- a/sphinx/themes/basic/genindex-single.html +++ b/sphinx/themes/basic/genindex-single.html @@ -4,7 +4,7 @@ Template for a "single" page of a split index. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. #} {% macro indexentries(firstname, links) %} diff --git a/sphinx/themes/basic/genindex-split.html b/sphinx/themes/basic/genindex-split.html index aca864781..ca8db18b0 100644 --- a/sphinx/themes/basic/genindex-split.html +++ b/sphinx/themes/basic/genindex-split.html @@ -4,7 +4,7 @@ Template for a "split" index overview page. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. #} {%- extends "layout.html" %} diff --git a/sphinx/themes/basic/genindex.html b/sphinx/themes/basic/genindex.html index 836d7844c..18e29b5e3 100644 --- a/sphinx/themes/basic/genindex.html +++ b/sphinx/themes/basic/genindex.html @@ -4,7 +4,7 @@ Template for an "all-in-one" index. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. #} {% macro indexentries(firstname, links) %} diff --git a/sphinx/themes/basic/globaltoc.html b/sphinx/themes/basic/globaltoc.html index 60ed28a38..9f0296a93 100644 --- a/sphinx/themes/basic/globaltoc.html +++ b/sphinx/themes/basic/globaltoc.html @@ -4,7 +4,7 @@ Sphinx sidebar template: global table of contents. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. #}

{{ _('Table Of Contents') }}

diff --git a/sphinx/themes/basic/layout.html b/sphinx/themes/basic/layout.html index 552da6381..36cd145a0 100644 --- a/sphinx/themes/basic/layout.html +++ b/sphinx/themes/basic/layout.html @@ -4,7 +4,7 @@ Master layout template for Sphinx themes. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. #} {%- block doctype -%} diff --git a/sphinx/themes/basic/localtoc.html b/sphinx/themes/basic/localtoc.html index 70afb6a5c..02e7cf38e 100644 --- a/sphinx/themes/basic/localtoc.html +++ b/sphinx/themes/basic/localtoc.html @@ -4,7 +4,7 @@ Sphinx sidebar template: local table of contents. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. #} {%- if display_toc %} diff --git a/sphinx/themes/basic/page.html b/sphinx/themes/basic/page.html index b4544a26e..e8be92e09 100644 --- a/sphinx/themes/basic/page.html +++ b/sphinx/themes/basic/page.html @@ -4,7 +4,7 @@ Master template for simple pages. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. #} {%- extends "layout.html" %} diff --git a/sphinx/themes/basic/relations.html b/sphinx/themes/basic/relations.html index c82bbee6f..907b38be1 100644 --- a/sphinx/themes/basic/relations.html +++ b/sphinx/themes/basic/relations.html @@ -4,7 +4,7 @@ Sphinx sidebar template: relation links. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. #} {%- if prev %} diff --git a/sphinx/themes/basic/search.html b/sphinx/themes/basic/search.html index 4a79aceca..d4a0b7d77 100644 --- a/sphinx/themes/basic/search.html +++ b/sphinx/themes/basic/search.html @@ -4,7 +4,7 @@ Template for the search page. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. #} {%- extends "layout.html" %} diff --git a/sphinx/themes/basic/searchbox.html b/sphinx/themes/basic/searchbox.html index 0a746f576..b5f875c8c 100644 --- a/sphinx/themes/basic/searchbox.html +++ b/sphinx/themes/basic/searchbox.html @@ -4,7 +4,7 @@ Sphinx sidebar template: quick search box. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. #} {%- if pagename != "search" and builder != "singlehtml" %} diff --git a/sphinx/themes/basic/searchresults.html b/sphinx/themes/basic/searchresults.html index b3d372c08..dccd20b6e 100644 --- a/sphinx/themes/basic/searchresults.html +++ b/sphinx/themes/basic/searchresults.html @@ -4,7 +4,7 @@ Template for the body of the search results page. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. #}

{{ _('Search') }}

diff --git a/sphinx/themes/basic/sourcelink.html b/sphinx/themes/basic/sourcelink.html index f3cb71fdd..9bf975777 100644 --- a/sphinx/themes/basic/sourcelink.html +++ b/sphinx/themes/basic/sourcelink.html @@ -4,7 +4,7 @@ Sphinx sidebar template: "show source" link. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. #} {%- if show_source and has_source and sourcename %} diff --git a/sphinx/themes/basic/static/basic.css_t b/sphinx/themes/basic/static/basic.css_t index 7ffa46641..99a8cfce4 100644 --- a/sphinx/themes/basic/static/basic.css_t +++ b/sphinx/themes/basic/static/basic.css_t @@ -4,7 +4,7 @@ * * Sphinx stylesheet -- basic theme. * - * :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ diff --git a/sphinx/themes/basic/static/doctools.js b/sphinx/themes/basic/static/doctools.js index c5455c905..40356f415 100644 --- a/sphinx/themes/basic/static/doctools.js +++ b/sphinx/themes/basic/static/doctools.js @@ -4,7 +4,7 @@ * * Sphinx JavaScript utilities for all documentation. * - * :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ diff --git a/sphinx/themes/basic/static/searchtools.js_t b/sphinx/themes/basic/static/searchtools.js_t index 047636c9f..90f7a655a 100644 --- a/sphinx/themes/basic/static/searchtools.js_t +++ b/sphinx/themes/basic/static/searchtools.js_t @@ -4,7 +4,7 @@ * * Sphinx JavaScript utilties for the full-text search. * - * :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ diff --git a/sphinx/themes/basic/static/websupport.js b/sphinx/themes/basic/static/websupport.js index 71c0a1364..37614a7f2 100644 --- a/sphinx/themes/basic/static/websupport.js +++ b/sphinx/themes/basic/static/websupport.js @@ -4,7 +4,7 @@ * * sphinx.websupport utilties for all documentation. * - * :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ diff --git a/sphinx/themes/default/layout.html b/sphinx/themes/default/layout.html index 62319059e..149cd86b7 100644 --- a/sphinx/themes/default/layout.html +++ b/sphinx/themes/default/layout.html @@ -4,7 +4,7 @@ Sphinx layout template for the default theme. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. #} {%- extends "basic/layout.html" %} diff --git a/sphinx/themes/default/static/default.css_t b/sphinx/themes/default/static/default.css_t index cbdc7fbbe..538146b84 100644 --- a/sphinx/themes/default/static/default.css_t +++ b/sphinx/themes/default/static/default.css_t @@ -4,7 +4,7 @@ * * Sphinx stylesheet -- default theme. * - * :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ diff --git a/sphinx/themes/default/static/sidebar.js_t b/sphinx/themes/default/static/sidebar.js_t index 873156920..5b38e532e 100644 --- a/sphinx/themes/default/static/sidebar.js_t +++ b/sphinx/themes/default/static/sidebar.js_t @@ -16,7 +16,7 @@ * Once the browser is closed the cookie is deleted and the position * reset to the default (expanded). * - * :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ diff --git a/sphinx/themes/epub/epub-cover.html b/sphinx/themes/epub/epub-cover.html index e5a75d7b6..86de4d488 100644 --- a/sphinx/themes/epub/epub-cover.html +++ b/sphinx/themes/epub/epub-cover.html @@ -4,7 +4,7 @@ Sample template for the html cover page. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. #} {%- extends "layout.html" %} diff --git a/sphinx/themes/epub/layout.html b/sphinx/themes/epub/layout.html index 49183f1ec..83706cf5f 100644 --- a/sphinx/themes/epub/layout.html +++ b/sphinx/themes/epub/layout.html @@ -4,7 +4,7 @@ Sphinx layout template for the epub theme. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. #} {%- extends "basic/layout.html" %} diff --git a/sphinx/themes/epub/static/epub.css b/sphinx/themes/epub/static/epub.css index 30912b9a8..25866d5b1 100644 --- a/sphinx/themes/epub/static/epub.css +++ b/sphinx/themes/epub/static/epub.css @@ -4,7 +4,7 @@ * * Sphinx stylesheet -- epub theme. * - * :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ @@ -531,4 +531,4 @@ table .link-target { src: url("res:///Data/fonts/LiberationNarrow-BoldItalic.otf") format("opentype"); } -*/ \ No newline at end of file +*/ diff --git a/sphinx/themes/haiku/layout.html b/sphinx/themes/haiku/layout.html index 569763bae..246c6dc86 100644 --- a/sphinx/themes/haiku/layout.html +++ b/sphinx/themes/haiku/layout.html @@ -4,7 +4,7 @@ Sphinx layout template for the haiku theme. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. #} {%- extends "basic/layout.html" %} diff --git a/sphinx/themes/haiku/static/haiku.css_t b/sphinx/themes/haiku/static/haiku.css_t index bd81db0a3..dde0862fe 100644 --- a/sphinx/themes/haiku/static/haiku.css_t +++ b/sphinx/themes/haiku/static/haiku.css_t @@ -16,7 +16,7 @@ * Braden Ewing * Humdinger * - * :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ diff --git a/sphinx/themes/nature/static/nature.css_t b/sphinx/themes/nature/static/nature.css_t index ff8914888..64cfa91f9 100644 --- a/sphinx/themes/nature/static/nature.css_t +++ b/sphinx/themes/nature/static/nature.css_t @@ -4,7 +4,7 @@ * * Sphinx stylesheet -- nature theme. * - * :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ diff --git a/sphinx/themes/pyramid/static/epub.css b/sphinx/themes/pyramid/static/epub.css index 7465a421c..7c76e7873 100644 --- a/sphinx/themes/pyramid/static/epub.css +++ b/sphinx/themes/pyramid/static/epub.css @@ -4,7 +4,7 @@ * * Sphinx stylesheet -- default theme. * - * :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ diff --git a/sphinx/themes/pyramid/static/pyramid.css_t b/sphinx/themes/pyramid/static/pyramid.css_t index 168e52db7..fac4f54aa 100644 --- a/sphinx/themes/pyramid/static/pyramid.css_t +++ b/sphinx/themes/pyramid/static/pyramid.css_t @@ -4,7 +4,7 @@ * * Sphinx stylesheet -- pylons theme. * - * :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ diff --git a/sphinx/themes/scrolls/layout.html b/sphinx/themes/scrolls/layout.html index a27f60a9a..11a7bb21e 100644 --- a/sphinx/themes/scrolls/layout.html +++ b/sphinx/themes/scrolls/layout.html @@ -5,7 +5,7 @@ Sphinx layout template for the scrolls theme, originally written by Armin Ronacher. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. #} {%- extends "basic/layout.html" %} diff --git a/sphinx/themes/scrolls/static/scrolls.css_t b/sphinx/themes/scrolls/static/scrolls.css_t index 197aef292..27f35ec4f 100644 --- a/sphinx/themes/scrolls/static/scrolls.css_t +++ b/sphinx/themes/scrolls/static/scrolls.css_t @@ -4,7 +4,7 @@ * * Sphinx stylesheet -- scrolls theme. * - * :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ diff --git a/sphinx/themes/sphinxdoc/layout.html b/sphinx/themes/sphinxdoc/layout.html index 5bf78eb5e..54c03fd55 100644 --- a/sphinx/themes/sphinxdoc/layout.html +++ b/sphinx/themes/sphinxdoc/layout.html @@ -4,7 +4,7 @@ Sphinx layout template for the sphinxdoc theme. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. #} {%- extends "basic/layout.html" %} diff --git a/sphinx/themes/sphinxdoc/static/sphinxdoc.css_t b/sphinx/themes/sphinxdoc/static/sphinxdoc.css_t index 0f3b9aa61..1799e1182 100644 --- a/sphinx/themes/sphinxdoc/static/sphinxdoc.css_t +++ b/sphinx/themes/sphinxdoc/static/sphinxdoc.css_t @@ -5,7 +5,7 @@ * Sphinx stylesheet -- sphinxdoc theme. Originally created by * Armin Ronacher for Werkzeug. * - * :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ diff --git a/sphinx/themes/traditional/static/traditional.css_t b/sphinx/themes/traditional/static/traditional.css_t index c0328b285..2a3ef80af 100644 --- a/sphinx/themes/traditional/static/traditional.css_t +++ b/sphinx/themes/traditional/static/traditional.css_t @@ -4,7 +4,7 @@ * * Sphinx stylesheet -- traditional docs.python.org theme. * - * :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ diff --git a/sphinx/theming.py b/sphinx/theming.py index abc09c17f..ad386655a 100644 --- a/sphinx/theming.py +++ b/sphinx/theming.py @@ -5,7 +5,7 @@ Theming support for HTML builders. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/transforms.py b/sphinx/transforms.py index 0e103acfb..a315c41fb 100644 --- a/sphinx/transforms.py +++ b/sphinx/transforms.py @@ -5,7 +5,7 @@ Docutils transforms used by Sphinx when reading documents. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/util/__init__.py b/sphinx/util/__init__.py index 91b7111ca..b4591c44b 100644 --- a/sphinx/util/__init__.py +++ b/sphinx/util/__init__.py @@ -5,7 +5,7 @@ Utility functions for Sphinx. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/util/compat.py b/sphinx/util/compat.py index 9e5d619dd..4be480246 100644 --- a/sphinx/util/compat.py +++ b/sphinx/util/compat.py @@ -5,7 +5,7 @@ Stuff for docutils compatibility. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/util/console.py b/sphinx/util/console.py index 24a22d754..2e65ef8d3 100644 --- a/sphinx/util/console.py +++ b/sphinx/util/console.py @@ -5,7 +5,7 @@ Format colored console output. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/util/docfields.py b/sphinx/util/docfields.py index d6f46ab99..9420b4a00 100644 --- a/sphinx/util/docfields.py +++ b/sphinx/util/docfields.py @@ -6,7 +6,7 @@ "Doc fields" are reST field lists in object descriptions that will be domain-specifically transformed to a more appealing presentation. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/util/docstrings.py b/sphinx/util/docstrings.py index c53977660..ab7832797 100644 --- a/sphinx/util/docstrings.py +++ b/sphinx/util/docstrings.py @@ -5,7 +5,7 @@ Utilities for docstring processing. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/util/inspect.py b/sphinx/util/inspect.py index cdbfea765..1671f9d2c 100644 --- a/sphinx/util/inspect.py +++ b/sphinx/util/inspect.py @@ -5,7 +5,7 @@ Helpers for inspecting Python modules. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/util/jsdump.py b/sphinx/util/jsdump.py index 85845a722..6447029be 100644 --- a/sphinx/util/jsdump.py +++ b/sphinx/util/jsdump.py @@ -6,7 +6,7 @@ This module implements a simple JavaScript serializer. Uses the basestring encode function from simplejson by Bob Ippolito. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/util/jsonimpl.py b/sphinx/util/jsonimpl.py index 8ccbf0cc4..8c51f4416 100644 --- a/sphinx/util/jsonimpl.py +++ b/sphinx/util/jsonimpl.py @@ -5,7 +5,7 @@ JSON serializer implementation wrapper. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/util/matching.py b/sphinx/util/matching.py index 51b2056d2..334ac9101 100644 --- a/sphinx/util/matching.py +++ b/sphinx/util/matching.py @@ -5,7 +5,7 @@ Pattern-matching utility functions for Sphinx. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/util/nodes.py b/sphinx/util/nodes.py index eb3b86b53..9a985c4fa 100644 --- a/sphinx/util/nodes.py +++ b/sphinx/util/nodes.py @@ -5,7 +5,7 @@ Docutils node-related utility functions for Sphinx. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/util/osutil.py b/sphinx/util/osutil.py index e98c49b20..549fe5c64 100644 --- a/sphinx/util/osutil.py +++ b/sphinx/util/osutil.py @@ -5,7 +5,7 @@ Operating system-related utility functions for Sphinx. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/util/png.py b/sphinx/util/png.py index 65fc4d8d2..e2dd2063b 100644 --- a/sphinx/util/png.py +++ b/sphinx/util/png.py @@ -5,7 +5,7 @@ PNG image manipulation helpers. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/util/pycompat.py b/sphinx/util/pycompat.py index a2b8d37ae..b8fe8255e 100644 --- a/sphinx/util/pycompat.py +++ b/sphinx/util/pycompat.py @@ -5,7 +5,7 @@ Stuff for Python version compatibility. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/util/tags.py b/sphinx/util/tags.py index 2a9b2a028..c87fdff5c 100644 --- a/sphinx/util/tags.py +++ b/sphinx/util/tags.py @@ -3,7 +3,7 @@ sphinx.util.tags ~~~~~~~~~~~~~~~~ - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/util/texescape.py b/sphinx/util/texescape.py index c0619f463..8a5e19797 100644 --- a/sphinx/util/texescape.py +++ b/sphinx/util/texescape.py @@ -5,7 +5,7 @@ TeX escaping helper. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/util/websupport.py b/sphinx/util/websupport.py index 65c48296e..2bb23fa81 100644 --- a/sphinx/util/websupport.py +++ b/sphinx/util/websupport.py @@ -3,7 +3,7 @@ sphinx.util.websupport ~~~~~~~~~~~~~~~~~~~~~~ - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/versioning.py b/sphinx/versioning.py index f10e0f21b..0631f09ed 100644 --- a/sphinx/versioning.py +++ b/sphinx/versioning.py @@ -6,7 +6,7 @@ Implements the low-level algorithms Sphinx uses for the versioning of doctrees. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ from uuid import uuid4 diff --git a/sphinx/websupport/__init__.py b/sphinx/websupport/__init__.py index 0e9131d0e..0c030b234 100644 --- a/sphinx/websupport/__init__.py +++ b/sphinx/websupport/__init__.py @@ -5,7 +5,7 @@ Base Module for web support functions. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/websupport/errors.py b/sphinx/websupport/errors.py index c401e8d98..1eda97e5c 100644 --- a/sphinx/websupport/errors.py +++ b/sphinx/websupport/errors.py @@ -5,7 +5,7 @@ Contains Error classes for the web support package. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/websupport/search/__init__.py b/sphinx/websupport/search/__init__.py index 45068d29b..4ff9939a2 100644 --- a/sphinx/websupport/search/__init__.py +++ b/sphinx/websupport/search/__init__.py @@ -5,7 +5,7 @@ Server side search support for the web support package. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/websupport/search/nullsearch.py b/sphinx/websupport/search/nullsearch.py index e842356d2..3d46555c0 100644 --- a/sphinx/websupport/search/nullsearch.py +++ b/sphinx/websupport/search/nullsearch.py @@ -5,7 +5,7 @@ The default search adapter, does nothing. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/websupport/search/whooshsearch.py b/sphinx/websupport/search/whooshsearch.py index 6d1f9de4a..94adc052a 100644 --- a/sphinx/websupport/search/whooshsearch.py +++ b/sphinx/websupport/search/whooshsearch.py @@ -5,7 +5,7 @@ Whoosh search adapter. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/websupport/search/xapiansearch.py b/sphinx/websupport/search/xapiansearch.py index bd24879cb..2d056bcce 100644 --- a/sphinx/websupport/search/xapiansearch.py +++ b/sphinx/websupport/search/xapiansearch.py @@ -5,7 +5,7 @@ Xapian search adapter. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/websupport/storage/__init__.py b/sphinx/websupport/storage/__init__.py index d9937d847..3f421a7ce 100644 --- a/sphinx/websupport/storage/__init__.py +++ b/sphinx/websupport/storage/__init__.py @@ -5,7 +5,7 @@ Storage for the websupport package. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/websupport/storage/differ.py b/sphinx/websupport/storage/differ.py index c6966a720..9ddd54764 100644 --- a/sphinx/websupport/storage/differ.py +++ b/sphinx/websupport/storage/differ.py @@ -5,7 +5,7 @@ A differ for creating an HTML representations of proposal diffs - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/websupport/storage/sqlalchemy_db.py b/sphinx/websupport/storage/sqlalchemy_db.py index 7baf8830a..7fc1d0b11 100644 --- a/sphinx/websupport/storage/sqlalchemy_db.py +++ b/sphinx/websupport/storage/sqlalchemy_db.py @@ -6,7 +6,7 @@ SQLAlchemy table and mapper definitions used by the :class:`sphinx.websupport.storage.sqlalchemystorage.SQLAlchemyStorage`. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/websupport/storage/sqlalchemystorage.py b/sphinx/websupport/storage/sqlalchemystorage.py index 354c710e5..6a9513770 100644 --- a/sphinx/websupport/storage/sqlalchemystorage.py +++ b/sphinx/websupport/storage/sqlalchemystorage.py @@ -5,7 +5,7 @@ An SQLAlchemy storage backend. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/writers/__init__.py b/sphinx/writers/__init__.py index a7541b279..fd795b0b9 100644 --- a/sphinx/writers/__init__.py +++ b/sphinx/writers/__init__.py @@ -5,6 +5,6 @@ Custom docutils writers. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/writers/html.py b/sphinx/writers/html.py index c69c2e092..bba352983 100644 --- a/sphinx/writers/html.py +++ b/sphinx/writers/html.py @@ -5,7 +5,7 @@ docutils writers handling Sphinx' custom nodes. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/writers/latex.py b/sphinx/writers/latex.py index eb637fc32..bed3f50c0 100644 --- a/sphinx/writers/latex.py +++ b/sphinx/writers/latex.py @@ -8,7 +8,7 @@ Much of this code is adapted from Dave Kuhlman's "docpy" writer from his docutils sandbox. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/writers/manpage.py b/sphinx/writers/manpage.py index 4b51588a4..4f9acd060 100644 --- a/sphinx/writers/manpage.py +++ b/sphinx/writers/manpage.py @@ -5,7 +5,7 @@ Manual page writer, extended for Sphinx custom nodes. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/writers/texinfo.py b/sphinx/writers/texinfo.py index fcfce03ee..7e02faf57 100644 --- a/sphinx/writers/texinfo.py +++ b/sphinx/writers/texinfo.py @@ -5,7 +5,7 @@ Custom docutils writer for Texinfo. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/writers/text.py b/sphinx/writers/text.py index e6238364d..1029cb53c 100644 --- a/sphinx/writers/text.py +++ b/sphinx/writers/text.py @@ -5,7 +5,7 @@ Custom docutils writer for plain text. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ import os diff --git a/sphinx/writers/websupport.py b/sphinx/writers/websupport.py index bc48c9595..0ba290249 100644 --- a/sphinx/writers/websupport.py +++ b/sphinx/writers/websupport.py @@ -5,7 +5,7 @@ sphinx.websupport writer that adds comment-related annotations. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/sphinx/writers/xml.py b/sphinx/writers/xml.py index cfae484ef..76828ce1f 100644 --- a/sphinx/writers/xml.py +++ b/sphinx/writers/xml.py @@ -5,7 +5,7 @@ Docutils-native XML and pseudo-XML writers. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/tests/path.py b/tests/path.py index fa90a6f5e..39d5f4af5 100755 --- a/tests/path.py +++ b/tests/path.py @@ -4,7 +4,7 @@ path ~~~~ - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ import os diff --git a/tests/run.py b/tests/run.py index 37922f3bb..fe31d20a9 100755 --- a/tests/run.py +++ b/tests/run.py @@ -6,7 +6,7 @@ This script runs the Sphinx unit test suite. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/tests/test_application.py b/tests/test_application.py index 3d464eb59..0a09a5285 100644 --- a/tests/test_application.py +++ b/tests/test_application.py @@ -5,7 +5,7 @@ Test the Sphinx class. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/tests/test_autodoc.py b/tests/test_autodoc.py index ed906d1c5..d91ea0449 100644 --- a/tests/test_autodoc.py +++ b/tests/test_autodoc.py @@ -6,7 +6,7 @@ Test the autodoc extension. This tests mainly the Documenters; the auto directives are tested in a test source file translated by test_build. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/tests/test_autosummary.py b/tests/test_autosummary.py index de26a0546..ee77ee26f 100644 --- a/tests/test_autosummary.py +++ b/tests/test_autosummary.py @@ -5,7 +5,7 @@ Test the autosummary extension. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ import sys diff --git a/tests/test_build.py b/tests/test_build.py index c355b1622..864453837 100644 --- a/tests/test_build.py +++ b/tests/test_build.py @@ -5,7 +5,7 @@ Test all builders that have no special checks. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/tests/test_build_gettext.py b/tests/test_build_gettext.py index 9bde44b5f..1197b2d7c 100644 --- a/tests/test_build_gettext.py +++ b/tests/test_build_gettext.py @@ -5,7 +5,7 @@ Test the build process with gettext builder with the test root. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/tests/test_build_html.py b/tests/test_build_html.py index c361f7786..606295e44 100644 --- a/tests/test_build_html.py +++ b/tests/test_build_html.py @@ -5,7 +5,7 @@ Test the HTML builder and check output against XPath. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/tests/test_build_latex.py b/tests/test_build_latex.py index 78aa71ccd..f77b3c268 100644 --- a/tests/test_build_latex.py +++ b/tests/test_build_latex.py @@ -5,7 +5,7 @@ Test the build process with LaTeX builder with the test root. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/tests/test_build_texinfo.py b/tests/test_build_texinfo.py index 2f519435a..7bef8c1ad 100644 --- a/tests/test_build_texinfo.py +++ b/tests/test_build_texinfo.py @@ -5,7 +5,7 @@ Test the build process with Texinfo builder with the test root. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/tests/test_build_text.py b/tests/test_build_text.py index e6e4d5be2..6ce216de2 100644 --- a/tests/test_build_text.py +++ b/tests/test_build_text.py @@ -5,7 +5,7 @@ Test the build process with Text builder with the test root. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/tests/test_config.py b/tests/test_config.py index 1e00091dd..546ace54b 100644 --- a/tests/test_config.py +++ b/tests/test_config.py @@ -6,7 +6,7 @@ Test the sphinx.config.Config class and its handling in the Application class. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ import sys diff --git a/tests/test_coverage.py b/tests/test_coverage.py index e6747b0c6..fd2bc13f8 100644 --- a/tests/test_coverage.py +++ b/tests/test_coverage.py @@ -5,7 +5,7 @@ Test the coverage builder. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/tests/test_cpp_domain.py b/tests/test_cpp_domain.py index 8e1cb22bb..136a20e55 100644 --- a/tests/test_cpp_domain.py +++ b/tests/test_cpp_domain.py @@ -5,7 +5,7 @@ Tests the C++ Domain - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/tests/test_doctest.py b/tests/test_doctest.py index 2aab541b8..8c6dd00d0 100644 --- a/tests/test_doctest.py +++ b/tests/test_doctest.py @@ -5,7 +5,7 @@ Test the doctest extension. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/tests/test_docutilsconf.py b/tests/test_docutilsconf.py index 4aeaa56a8..913e1e3cc 100644 --- a/tests/test_docutilsconf.py +++ b/tests/test_docutilsconf.py @@ -5,7 +5,7 @@ Test docutils.conf support for several writers. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/tests/test_env.py b/tests/test_env.py index c5a091cda..3dd8c4efc 100644 --- a/tests/test_env.py +++ b/tests/test_env.py @@ -5,7 +5,7 @@ Test the BuildEnvironment class. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ import os diff --git a/tests/test_footnote.py b/tests/test_footnote.py index 964bb3e7f..d9c510a76 100644 --- a/tests/test_footnote.py +++ b/tests/test_footnote.py @@ -5,7 +5,7 @@ Test for footnote and citation. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/tests/test_highlighting.py b/tests/test_highlighting.py index b4e5149f5..b57708976 100644 --- a/tests/test_highlighting.py +++ b/tests/test_highlighting.py @@ -5,7 +5,7 @@ Test the Pygments highlighting bridge. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/tests/test_i18n.py b/tests/test_i18n.py index 06f6b28bd..4fe979149 100644 --- a/tests/test_i18n.py +++ b/tests/test_i18n.py @@ -5,7 +5,7 @@ Test locale features. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/tests/test_intersphinx.py b/tests/test_intersphinx.py index 8f0263b96..96f0ad9df 100644 --- a/tests/test_intersphinx.py +++ b/tests/test_intersphinx.py @@ -5,7 +5,7 @@ Test the intersphinx extension. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/tests/test_intl.py b/tests/test_intl.py index ca0273c8e..e3d91ca8e 100644 --- a/tests/test_intl.py +++ b/tests/test_intl.py @@ -6,7 +6,7 @@ Test message patching for internationalization purposes. Runs the text builder in the test root. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/tests/test_linkcode.py b/tests/test_linkcode.py index 83b720984..518e124e2 100644 --- a/tests/test_linkcode.py +++ b/tests/test_linkcode.py @@ -5,7 +5,7 @@ Test the sphinx.ext.linkcode extension. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/tests/test_markup.py b/tests/test_markup.py index 4f0b0de8b..e9af4478e 100644 --- a/tests/test_markup.py +++ b/tests/test_markup.py @@ -5,7 +5,7 @@ Test various Sphinx-specific markup extensions. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/tests/test_metadata.py b/tests/test_metadata.py index a0d444574..1549f6574 100644 --- a/tests/test_metadata.py +++ b/tests/test_metadata.py @@ -5,7 +5,7 @@ Test our handling of metadata in files with bibliographic metadata. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/tests/test_only_directive.py b/tests/test_only_directive.py index 4717ff9f2..43af5e7d2 100644 --- a/tests/test_only_directive.py +++ b/tests/test_only_directive.py @@ -5,7 +5,7 @@ Test the only directive with the test root. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/tests/test_py_domain.py b/tests/test_py_domain.py index 68634d832..c3f0b0cc3 100644 --- a/tests/test_py_domain.py +++ b/tests/test_py_domain.py @@ -5,7 +5,7 @@ Tests the Python Domain - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/tests/test_quickstart.py b/tests/test_quickstart.py index 8f630700f..da4ba4257 100644 --- a/tests/test_quickstart.py +++ b/tests/test_quickstart.py @@ -5,7 +5,7 @@ Test the sphinx.quickstart module. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/tests/test_rst_domain.py b/tests/test_rst_domain.py index 9f70f5b1f..7dabebe06 100644 --- a/tests/test_rst_domain.py +++ b/tests/test_rst_domain.py @@ -5,7 +5,7 @@ Tests the reStructuredText domain. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/tests/test_search.py b/tests/test_search.py index 2efd753cc..bff9b4d8f 100644 --- a/tests/test_search.py +++ b/tests/test_search.py @@ -5,7 +5,7 @@ Test the search index builder. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/tests/test_searchadapters.py b/tests/test_searchadapters.py index 81d7c1784..68e4c6bad 100644 --- a/tests/test_searchadapters.py +++ b/tests/test_searchadapters.py @@ -5,7 +5,7 @@ Test the Web Support Package search adapters. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/tests/test_setup_command.py b/tests/test_setup_command.py index c165b2d33..fa49e27ad 100644 --- a/tests/test_setup_command.py +++ b/tests/test_setup_command.py @@ -5,7 +5,7 @@ Test setup_command for distutils. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/tests/test_templating.py b/tests/test_templating.py index e8fafca2b..ca1569f26 100644 --- a/tests/test_templating.py +++ b/tests/test_templating.py @@ -5,7 +5,7 @@ Test templating. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/tests/test_theming.py b/tests/test_theming.py index 7f91a32a3..0cbf0f8ad 100644 --- a/tests/test_theming.py +++ b/tests/test_theming.py @@ -5,7 +5,7 @@ Test the Theme class. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/tests/test_util_nodes.py b/tests/test_util_nodes.py index 9ddc049dc..16e623ebf 100644 --- a/tests/test_util_nodes.py +++ b/tests/test_util_nodes.py @@ -5,7 +5,7 @@ Tests uti.nodes functions. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ from textwrap import dedent diff --git a/tests/test_versioning.py b/tests/test_versioning.py index bf2f65eef..df14dec3b 100644 --- a/tests/test_versioning.py +++ b/tests/test_versioning.py @@ -5,7 +5,7 @@ Test the versioning implementation. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/tests/test_websupport.py b/tests/test_websupport.py index 9376a2a21..2bf83657d 100644 --- a/tests/test_websupport.py +++ b/tests/test_websupport.py @@ -5,7 +5,7 @@ Test the Web Support Package - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/tests/util.py b/tests/util.py index 61c9bd0d4..2397d7374 100644 --- a/tests/util.py +++ b/tests/util.py @@ -3,7 +3,7 @@ Sphinx test suite utilities ~~~~~~~~~~~~~~~~~~~~~~~~~~~ - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/utils/check_sources.py b/utils/check_sources.py index 7bbd0a79b..e01e15c7b 100755 --- a/utils/check_sources.py +++ b/utils/check_sources.py @@ -7,7 +7,7 @@ Make sure each Python file has a correct file header including copyright and license information. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ diff --git a/utils/convert.py b/utils/convert.py index c90be8e6d..42b77e0c3 100755 --- a/utils/convert.py +++ b/utils/convert.py @@ -8,7 +8,7 @@ The Python3 version of a file foo.py will be called foo3.py. - :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ import os From d79bedb69a790640fafdc43ab47104f0c0be98b7 Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Sat, 3 Jan 2015 21:41:31 +0100 Subject: [PATCH 02/40] license: fix copyright year --- LICENSE | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/LICENSE b/LICENSE index 7aa7620b5..64ae7baee 100644 --- a/LICENSE +++ b/LICENSE @@ -1,7 +1,7 @@ License for Sphinx ================== -Copyright (c) 2007-2013 by the Sphinx team (see AUTHORS file). +Copyright (c) 2007-2015 by the Sphinx team (see AUTHORS file). All rights reserved. Redistribution and use in source and binary forms, with or without From 5d64cc0cc55d005bee8e083b69a4b7d18a9cf80f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ionel=20Cristian=20M=C4=83rie=C8=99?= Date: Sun, 4 Jan 2015 00:16:39 +0200 Subject: [PATCH 03/40] Correct few "typos". --- README.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 10e2a9ee6..94567ecf6 100644 --- a/README.rst +++ b/README.rst @@ -51,8 +51,8 @@ Contributing feature idea or a bug. #. If you feel uncomfortable or uncertain about an issue or your changes, feel free to email sphinx-dev@googlegroups.com. -#. Fork the repository on Bitbucket https://github.com/sphinx-doc/sphinx - to start making your changes to the **default** branch for next major +#. Fork the repository on GitHub https://github.com/sphinx-doc/sphinx + to start making your changes to the **master** branch for next major version, or **stable** branch for next minor version. #. Write a test which shows that the bug was fixed or that the feature works as expected. From a63e4945ea82ce76e3600150862bcaaed759ba8b Mon Sep 17 00:00:00 2001 From: EricFromCanada Date: Mon, 5 Jan 2015 12:49:06 -0500 Subject: [PATCH 04/40] Add highlight_options configuration value This changeset adds the `highlight_options` configuration value, which specifies a dict of key-value pairs to pass to the Pygments highlighter specified with `highlight_language`. For example, specifying `highlight_options = {'funcnamehighlighting' : False}` for the 'php' lexer will disable function name highlighting. Both the HTML and LaTeX writers have been updated to include the options when calling `highlight_block()`, as long as the currently selected language matches what was set with `highlight_language`, i.e. not when modified by `highlight::` or `code-block::` directives. --- CHANGES | 2 ++ doc/config.rst | 10 +++++++++- sphinx/config.py | 1 + sphinx/highlighting.py | 4 ++-- sphinx/writers/html.py | 11 +++++++++-- sphinx/writers/latex.py | 9 +++++++-- tests/test_highlighting.py | 6 ++++++ 7 files changed, 36 insertions(+), 7 deletions(-) diff --git a/CHANGES b/CHANGES index d84f2ff94..1909ffddb 100644 --- a/CHANGES +++ b/CHANGES @@ -9,6 +9,8 @@ Incompatible changes Features added -------------- +* Added ``highlight_options`` configuration value. + Bugs fixed ---------- diff --git a/doc/config.rst b/doc/config.rst index 5b72f2722..94e33f456 100644 --- a/doc/config.rst +++ b/doc/config.rst @@ -303,9 +303,17 @@ Project information .. versionadded:: 0.5 +.. confval:: highlight_options + + A dictionary of options that modify the behavior of the lexer for the + selected language. These are lexer-specific. For the options understood by + each, see the `Pygments documentation `_. + + .. versionadded:: 1.3 + .. confval:: pygments_style - The style name to use for Pygments highlighting of source code. The default + The style name to use for Pygments highlighting of source code. The given style is selected by the theme for HTML output, and ``'sphinx'`` otherwise. .. versionchanged:: 0.3 diff --git a/sphinx/config.py b/sphinx/config.py index be9b66f72..145e60675 100644 --- a/sphinx/config.py +++ b/sphinx/config.py @@ -61,6 +61,7 @@ class Config(object): show_authors = (False, 'env'), pygments_style = (None, 'html'), highlight_language = ('python', 'env'), + highlight_options = ({}, 'env'), templates_path = ([], 'html'), template_bridge = (None, 'html'), keep_warnings = (False, 'env'), diff --git a/sphinx/highlighting.py b/sphinx/highlighting.py index b6062e83e..63a46fbd7 100644 --- a/sphinx/highlighting.py +++ b/sphinx/highlighting.py @@ -134,7 +134,7 @@ class PygmentsBridge(object): else: return True - def highlight_block(self, source, lang, warn=None, force=False, **kwargs): + def highlight_block(self, source, lang, opts=None, warn=None, force=False, **kwargs): if not isinstance(source, text_type): source = source.decode() @@ -164,7 +164,7 @@ class PygmentsBridge(object): lexer = lexers[lang] else: try: - lexer = lexers[lang] = get_lexer_by_name(lang) + lexer = lexers[lang] = get_lexer_by_name(lang, **opts) except ClassNotFound: if warn: warn('Pygments lexer name %r is not known' % lang) diff --git a/sphinx/writers/html.py b/sphinx/writers/html.py index ba3129f79..c63b27698 100644 --- a/sphinx/writers/html.py +++ b/sphinx/writers/html.py @@ -70,7 +70,9 @@ class HTMLTranslator(BaseTranslator): self.highlighter = builder.highlighter self.no_smarty = 0 self.builder = builder - self.highlightlang = builder.config.highlight_language + self.highlightlang = self.highlightlang_base = \ + builder.config.highlight_language + self.highlightopts = builder.config.highlight_options self.highlightlinenothreshold = sys.maxsize self.protect_literal_text = 0 self.permalink_text = builder.config.html_add_permalinks @@ -301,10 +303,15 @@ class HTMLTranslator(BaseTranslator): highlight_args['force'] = True if 'linenos' in node: linenos = node['linenos'] + if lang is self.highlightlang_base: + # only pass highlighter options for original language + opts = self.highlightopts + else: + opts = {} def warner(msg): self.builder.warn(msg, (self.builder.current_docname, node.line)) highlighted = self.highlighter.highlight_block( - node.rawsource, lang, warn=warner, linenos=linenos, + node.rawsource, lang, opts=opts, warn=warner, linenos=linenos, **highlight_args) starttag = self.starttag(node, 'div', suffix='', CLASS='highlight-%s' % lang) diff --git a/sphinx/writers/latex.py b/sphinx/writers/latex.py index 27e6d5f2c..c96b4df2f 100644 --- a/sphinx/writers/latex.py +++ b/sphinx/writers/latex.py @@ -1378,10 +1378,15 @@ class LaTeXTranslator(nodes.NodeVisitor): highlight_args['force'] = True if 'linenos' in node: linenos = node['linenos'] + if lang is self.hlsettingstack[0][0]: + # only pass highlighter options for original language + opts = self.builder.config.highlight_options + else: + opts = {} def warner(msg): self.builder.warn(msg, (self.curfilestack[-1], node.line)) - hlcode = self.highlighter.highlight_block(code, lang, warn=warner, - linenos=linenos, **highlight_args) + hlcode = self.highlighter.highlight_block(code, lang, opts=opts, + warn=warner, linenos=linenos, **highlight_args) # workaround for Unicode issue hlcode = hlcode.replace(u'€', u'@texteuro[]') # must use original Verbatim environment and "tabular" environment diff --git a/tests/test_highlighting.py b/tests/test_highlighting.py index c3ea03873..02b928916 100644 --- a/tests/test_highlighting.py +++ b/tests/test_highlighting.py @@ -62,6 +62,12 @@ def test_detect_interactive(): assert ret.startswith("
") +def test_lexer_options(): + bridge = PygmentsBridge('html') + ret = bridge.highlight_block('//comment', 'php', opts={'startinline' : True}) + assert '//comment' in ret + + def test_set_formatter(): PygmentsBridge.html_formatter = MyFormatter try: From 3111f7b6b35c581b2e0adfe915604cd2e0203612 Mon Sep 17 00:00:00 2001 From: EricFromCanada Date: Mon, 5 Jan 2015 23:22:19 -0500 Subject: [PATCH 05/40] rewording of `highlight_options` description --- doc/config.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/doc/config.rst b/doc/config.rst index 94e33f456..98db4569b 100644 --- a/doc/config.rst +++ b/doc/config.rst @@ -305,9 +305,10 @@ Project information .. confval:: highlight_options - A dictionary of options that modify the behavior of the lexer for the - selected language. These are lexer-specific. For the options understood by - each, see the `Pygments documentation `_. + A dictionary of options that modify how the lexer specified by + :confval:`highlight_language` generates highlighted source code. These are + lexer-specific; for the options understood by each, see the + `Pygments documentation `_. .. versionadded:: 1.3 From 5d96523f7d44612d6770c0f3be19555415f19f44 Mon Sep 17 00:00:00 2001 From: EricFromCanada Date: Mon, 5 Jan 2015 12:28:44 -0500 Subject: [PATCH 06/40] Fix LaTeX writer's handling of multirow table cells Originally the LaTeX writer could only handle one multirow cell per row. This commit fixes that and adds support for cells spanning both rows and columns. --- CHANGES | 2 ++ sphinx/writers/latex.py | 71 ++++++++++++++++++++++++++++++----------- tests/root/markup.txt | 16 +++++----- 3 files changed, 62 insertions(+), 27 deletions(-) diff --git a/CHANGES b/CHANGES index d84f2ff94..a2b56cc5f 100644 --- a/CHANGES +++ b/CHANGES @@ -12,6 +12,8 @@ Features added Bugs fixed ---------- +* LaTeX writer now generates correct markup for cells spanning multiple rows. + Release 1.3b2 (released Dec 5, 2014) ==================================== diff --git a/sphinx/writers/latex.py b/sphinx/writers/latex.py index 27e6d5f2c..842727b8a 100644 --- a/sphinx/writers/latex.py +++ b/sphinx/writers/latex.py @@ -288,9 +288,8 @@ class LaTeXTranslator(nodes.NodeVisitor): self.no_contractions = 0 self.compact_list = 0 self.first_param = 0 - self.previous_spanning_row = 0 - self.previous_spanning_column = 0 self.remember_multirow = {} + self.remember_multirowcol = {} def format_docclass(self, docclass): """ prepends prefix to sphinx document classes @@ -767,32 +766,49 @@ class LaTeXTranslator(nodes.NodeVisitor): self.visit_thead(node) self.body = self.tablebody def depart_tbody(self, node): - pass + self.remember_multirow = {} + self.remember_multirowcol = {} def visit_row(self, node): self.table.col = 0 + for key,value in self.remember_multirow.items(): + if not value and key in self.remember_multirowcol: + del self.remember_multirowcol[key] def depart_row(self, node): - if self.previous_spanning_row == 1: - self.previous_spanning_row = 0 self.body.append('\\\\\n') - self.body.append('\\hline') + if any(self.remember_multirow.values()): + linestart = 1 + for col in range(1, self.table.col + 1): + if self.remember_multirow.get(col): + if linestart != col: + linerange = str(linestart) + '-' + str(col - 1) + self.body.append('\\cline{' + linerange + '}') + linestart = col + 1 + if self.remember_multirowcol.get(col, 0): + linestart += self.remember_multirowcol[col] + if linestart <= col: + linerange = str(linestart) + '-' + str(col) + self.body.append('\\cline{' + linerange + '}') + else: + self.body.append('\\hline') self.table.rowcount += 1 def visit_entry(self, node): - if self.table.col > 0: - self.body.append(' & ') - elif self.remember_multirow.get(1, 0) > 1: - self.remember_multirow[1] -= 1 + if self.table.col == 0: + while self.remember_multirow.get(self.table.col + 1, 0): + self.table.col += 1 + self.remember_multirow[self.table.col] -= 1 + if self.remember_multirowcol.get(self.table.col, 0): + extracols = self.remember_multirowcol[self.table.col] + self.body.append(' \multicolumn{') + self.body.append(str(extracols + 1)) + self.body.append('}{|l|}{}') + self.table.col += extracols + self.body.append(' & ') + else: self.body.append(' & ') self.table.col += 1 context = '' - if 'morerows' in node: - self.body.append(' \multirow{') - self.previous_spanning_row = 1 - self.body.append(str(node.get('morerows') + 1)) - self.body.append('}{*}{') - context += '}' - self.remember_multirow[self.table.col] = node.get('morerows') + 1 if 'morecols' in node: self.body.append(' \multicolumn{') self.body.append(str(node.get('morecols') + 1)) @@ -801,12 +817,29 @@ class LaTeXTranslator(nodes.NodeVisitor): else: self.body.append('}{l|}{') context += '}' + if 'morerows' in node: + self.body.append(' \multirow{') + self.body.append(str(node.get('morerows') + 1)) + self.body.append('}{*}{') + context += '}' + self.remember_multirow[self.table.col] = node.get('morerows') + if 'morecols' in node: + if 'morerows' in node: + self.remember_multirowcol[self.table.col] = node.get('morecols') + self.table.col += node.get('morecols') if isinstance(node.parent.parent, nodes.thead): self.body.append('\\textsf{\\relax ') context += '}' - if self.remember_multirow.get(self.table.col + 1, 0) > 1: - self.remember_multirow[self.table.col + 1] -= 1 + while self.remember_multirow.get(self.table.col + 1, 0): + self.table.col += 1 + self.remember_multirow[self.table.col] -= 1 context += ' & ' + if self.remember_multirowcol.get(self.table.col, 0): + extracols = self.remember_multirowcol[self.table.col] + context += ' \multicolumn{' + context += str(extracols + 1) + context += '}{l|}{}' + self.table.col += extracols self.context.append(context) def depart_entry(self, node): self.body.append(self.context.pop()) # header diff --git a/tests/root/markup.txt b/tests/root/markup.txt index 1ad7a13b6..4d109eb6b 100644 --- a/tests/root/markup.txt +++ b/tests/root/markup.txt @@ -180,17 +180,17 @@ Tables | 2 | Empty cells: | | +----+----------------+----+ -Table with multicol: +Table with multirow and multicol: .. only:: latex - +----+---------------------+ - | 1 | test! | - +----+---------+------+----+ - | 2 | col | col | c | - | y +---------+------+----+ - | x | test | - +----+---------------------+ + +----+----------------+---------+ + | 1 | test! | c | + +----+---------+------+ | + | 2 | col | col | | + | y +---------+------+----+----+ + | x | multi-column cell | x | + +----+---------------------+----+ Figures From ddb7c9945dd988b2c29ff8cac1f35184a5be9d3e Mon Sep 17 00:00:00 2001 From: shimizukawa Date: Tue, 6 Jan 2015 22:23:05 +0900 Subject: [PATCH 07/40] Exclude 'tests' instead of 'test'. Sphinx-1.2.3 wheel package includes 'tests' directory. It might be happen by this wrong parameter. --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 9872226ee..00affb13e 100644 --- a/setup.py +++ b/setup.py @@ -185,7 +185,7 @@ setup( 'Topic :: Utilities', ], platforms='any', - packages=find_packages(exclude=['custom_fixers', 'test']), + packages=find_packages(exclude=['custom_fixers', 'tests']), include_package_data=True, entry_points={ 'console_scripts': [ From 0f0ffbb9827f55807ddbd6bdd9c3096bb539fc55 Mon Sep 17 00:00:00 2001 From: EricFromCanada Date: Tue, 6 Jan 2015 10:51:54 -0500 Subject: [PATCH 08/40] revised pygments_style description --- doc/config.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/config.rst b/doc/config.rst index 98db4569b..e733fa62b 100644 --- a/doc/config.rst +++ b/doc/config.rst @@ -314,8 +314,8 @@ Project information .. confval:: pygments_style - The style name to use for Pygments highlighting of source code. The given - style is selected by the theme for HTML output, and ``'sphinx'`` otherwise. + The style name to use for Pygments highlighting of source code. If not set, + either the theme's default style or ``'sphinx'`` is selected for HTML output. .. versionchanged:: 0.3 If the value is a fully-qualified name of a custom Pygments style class, From b9fe829e026e8d3cfaf774dfc8144d3dc2239e69 Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Tue, 6 Jan 2015 17:10:43 +0100 Subject: [PATCH 09/40] highlighting: fix potential TypeError --- sphinx/highlighting.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sphinx/highlighting.py b/sphinx/highlighting.py index 63a46fbd7..58365b35c 100644 --- a/sphinx/highlighting.py +++ b/sphinx/highlighting.py @@ -164,7 +164,7 @@ class PygmentsBridge(object): lexer = lexers[lang] else: try: - lexer = lexers[lang] = get_lexer_by_name(lang, **opts) + lexer = lexers[lang] = get_lexer_by_name(lang, **opts or {}) except ClassNotFound: if warn: warn('Pygments lexer name %r is not known' % lang) From 21b838454f4bb5b6a246b85cb2f521deb7552505 Mon Sep 17 00:00:00 2001 From: Luc Saffre Date: Sat, 3 Jan 2015 20:32:44 +0200 Subject: [PATCH 10/40] autodoc: use sourcename also for content generated by autodoc itself Fixes #1061 Fixes #1656 --- sphinx/ext/autodoc.py | 50 ++++++++++++++++++------------ sphinx/ext/autosummary/__init__.py | 7 +++-- 2 files changed, 35 insertions(+), 22 deletions(-) diff --git a/sphinx/ext/autodoc.py b/sphinx/ext/autodoc.py index cf87a1c2e..7c2f35f4e 100644 --- a/sphinx/ext/autodoc.py +++ b/sphinx/ext/autodoc.py @@ -481,14 +481,15 @@ class Documenter(object): domain = getattr(self, 'domain', 'py') directive = getattr(self, 'directivetype', self.objtype) name = self.format_name() + sourcename = self.get_sourcename() self.add_line(u'.. %s:%s:: %s%s' % (domain, directive, name, sig), - '') + sourcename) if self.options.noindex: - self.add_line(u' :noindex:', '') + self.add_line(u' :noindex:', sourcename) if self.objpath: # Be explicit about the module, this is necessary since .. class:: # etc. don't support a prepended module name - self.add_line(u' :module: %s' % self.modname, '') + self.add_line(u' :module: %s' % self.modname, sourcename) def get_doc(self, encoding=None, ignore=1): """Decode and return lines of the docstring(s) for the object.""" @@ -514,9 +515,7 @@ class Documenter(object): for line in docstringlines: yield line - def add_content(self, more_content, no_docstring=False): - """Add content from docstrings, attribute documentation and user.""" - # set sourcename and add content from attribute documentation + def get_sourcename(self): if self.analyzer: # prevent encoding errors when the file name is non-ASCII if not isinstance(self.analyzer.srcname, text_type): @@ -524,8 +523,14 @@ class Documenter(object): sys.getfilesystemencoding(), 'replace') else: filename = self.analyzer.srcname - sourcename = u'%s:docstring of %s' % (filename, self.fullname) + return u'%s:docstring of %s' % (filename, self.fullname) + return u'docstring of %s' % self.fullname + def add_content(self, more_content, no_docstring=False): + """Add content from docstrings, attribute documentation and user.""" + # set sourcename and add content from attribute documentation + sourcename = self.get_sourcename() + if self.analyzer: attr_docs = self.analyzer.find_attr_docs() if self.objpath: key = ('.'.join(self.objpath[:-1]), self.objpath[-1]) @@ -534,8 +539,6 @@ class Documenter(object): docstrings = [attr_docs[key]] for i, line in enumerate(self.process_doc(docstrings)): self.add_line(line, sourcename, i) - else: - sourcename = u'docstring of %s' % self.fullname # add content from docstrings if not no_docstring: @@ -794,17 +797,19 @@ class Documenter(object): if not self.check_module(): return + sourcename = self.get_sourcename() + # 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'', sourcename) # format the object's signature, if any sig = self.format_signature() # generate the directive header and options, if applicable self.add_directive_header(sig) - self.add_line(u'', '') + self.add_line(u'', sourcename) # e.g. the module directive doesn't have content self.indent += self.content_indent @@ -854,15 +859,17 @@ class ModuleDocumenter(Documenter): def add_directive_header(self, sig): Documenter.add_directive_header(self, sig) + sourcename = self.get_sourcename() + # add some module-specific options if self.options.synopsis: self.add_line( - u' :synopsis: ' + self.options.synopsis, '') + u' :synopsis: ' + self.options.synopsis, sourcename) if self.options.platform: self.add_line( - u' :platform: ' + self.options.platform, '') + u' :platform: ' + self.options.platform, sourcename) if self.options.deprecated: - self.add_line(u' :deprecated:', '') + self.add_line(u' :deprecated:', sourcename) def get_object_members(self, want_all): if want_all: @@ -1108,14 +1115,15 @@ class ClassDocumenter(DocstringSignatureMixin, ModuleLevelDocumenter): # add inheritance info, if wanted if not self.doc_as_attr and self.options.show_inheritance: - self.add_line(u'', '') + sourcename = self.get_sourcename() + self.add_line(u'', sourcename) if hasattr(self.object, '__bases__') and len(self.object.__bases__): bases = [b.__module__ in ('__builtin__', 'builtins') and u':class:`%s`' % b.__name__ or u':class:`%s.%s`' % (b.__module__, b.__name__) for b in self.object.__bases__] self.add_line(_(u' Bases: %s') % ', '.join(bases), - '') + sourcename) def get_doc(self, encoding=None, ignore=1): lines = getattr(self, '_new_docstrings', None) @@ -1200,18 +1208,19 @@ class DataDocumenter(ModuleLevelDocumenter): def add_directive_header(self, sig): ModuleLevelDocumenter.add_directive_header(self, sig) + sourcename = self.get_sourcename() if not self.options.annotation: try: objrepr = safe_repr(self.object) except ValueError: pass else: - self.add_line(u' :annotation: = ' + objrepr, '') + self.add_line(u' :annotation: = ' + objrepr, sourcename) elif self.options.annotation is SUPPRESS: pass else: self.add_line(u' :annotation: %s' % self.options.annotation, - '') + sourcename) def document_members(self, all_members=False): pass @@ -1311,6 +1320,7 @@ class AttributeDocumenter(DocstringStripSignatureMixin, ClassLevelDocumenter): def add_directive_header(self, sig): ClassLevelDocumenter.add_directive_header(self, sig) + sourcename = self.get_sourcename() if not self.options.annotation: if not self._datadescriptor: try: @@ -1318,12 +1328,12 @@ class AttributeDocumenter(DocstringStripSignatureMixin, ClassLevelDocumenter): except ValueError: pass else: - self.add_line(u' :annotation: = ' + objrepr, '') + self.add_line(u' :annotation: = ' + objrepr, sourcename) elif self.options.annotation is SUPPRESS: pass else: self.add_line(u' :annotation: %s' % self.options.annotation, - '') + sourcename) def add_content(self, more_content, no_docstring=False): if not self._datadescriptor: diff --git a/sphinx/ext/autosummary/__init__.py b/sphinx/ext/autosummary/__init__.py index 9be392371..08a855846 100644 --- a/sphinx/ext/autosummary/__init__.py +++ b/sphinx/ext/autosummary/__init__.py @@ -69,6 +69,7 @@ import sphinx from sphinx import addnodes from sphinx.util.compat import Directive from sphinx.pycode import ModuleAnalyzer, PycodeError +from sphinx.ext.autodoc import Options # -- autosummary_toc node ------------------------------------------------------ @@ -131,7 +132,7 @@ def autosummary_table_visit_html(self, node): class FakeDirective: env = {} - genopt = {} + genopt = Options() def get_documenter(obj, parent): """Get an autodoc.Documenter class suitable for documenting the given @@ -194,7 +195,7 @@ class Autosummary(Directive): def run(self): self.env = env = self.state.document.settings.env - self.genopt = {} + self.genopt = Options() self.warnings = [] self.result = ViewList() @@ -269,6 +270,8 @@ class Autosummary(Directive): self.warn('failed to import object %s' % real_name) items.append((display_name, '', '', real_name)) continue + if not documenter.check_module(): + continue # try to also get a source code analyzer for attribute docs try: From 12bf3b69ce33a1c4fef26740fc791f8255797cfc Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Thu, 8 Jan 2015 08:12:17 +0100 Subject: [PATCH 11/40] napoleon: fix handling of blocks when there is a prefix but no line content Closes #1542. --- sphinx/ext/napoleon/docstring.py | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/sphinx/ext/napoleon/docstring.py b/sphinx/ext/napoleon/docstring.py index 4cb17eaf0..4b8b6683e 100644 --- a/sphinx/ext/napoleon/docstring.py +++ b/sphinx/ext/napoleon/docstring.py @@ -291,11 +291,10 @@ class GoogleDocstring(UnicodeMixin): padding = ' ' * len(prefix) result_lines = [] for i, line in enumerate(lines): - if line: - if i == 0: - result_lines.append(prefix + line) - else: - result_lines.append(padding + line) + if i == 0: + result_lines.append(prefix + line) + elif line: + result_lines.append(padding + line) else: result_lines.append('') return result_lines From 0071ac83992d5d73793f510dfd1a87da23899031 Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Fri, 9 Jan 2015 18:41:09 +0100 Subject: [PATCH 12/40] Test fixup. --- sphinx/ext/napoleon/docstring.py | 2 +- tests/test_ext_napoleon_docstring.py | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/sphinx/ext/napoleon/docstring.py b/sphinx/ext/napoleon/docstring.py index 4b8b6683e..4902c3099 100644 --- a/sphinx/ext/napoleon/docstring.py +++ b/sphinx/ext/napoleon/docstring.py @@ -292,7 +292,7 @@ class GoogleDocstring(UnicodeMixin): result_lines = [] for i, line in enumerate(lines): if i == 0: - result_lines.append(prefix + line) + result_lines.append((prefix + line).rstrip()) elif line: result_lines.append(padding + line) else: diff --git a/tests/test_ext_napoleon_docstring.py b/tests/test_ext_napoleon_docstring.py index 7b316ef97..853e73624 100644 --- a/tests/test_ext_napoleon_docstring.py +++ b/tests/test_ext_napoleon_docstring.py @@ -362,7 +362,7 @@ param1 : :class:`MyClass ` instance config = Config(napoleon_use_param=True) actual = str(NumpyDocstring(docstring, config)) expected = """\ - +:param param1: :type param1: :class:`MyClass ` instance """ self.assertEqual(expected, actual) @@ -385,7 +385,7 @@ param1 : MyClass instance config = Config(napoleon_use_param=True) actual = str(NumpyDocstring(textwrap.dedent(docstring), config)) expected = """\ - +:param param1: :type param1: MyClass instance """ self.assertEqual(expected, actual) From dee3e60ee69517f737b70a9a096e8956ec447112 Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Sat, 10 Jan 2015 19:40:59 +0100 Subject: [PATCH 13/40] Closes #1669: make "language" available in HTML templates. --- CHANGES | 1 + sphinx/builders/html.py | 1 + 2 files changed, 2 insertions(+) diff --git a/CHANGES b/CHANGES index e9b52f1cc..7a479629c 100644 --- a/CHANGES +++ b/CHANGES @@ -10,6 +10,7 @@ Features added -------------- * Added ``highlight_options`` configuration value. +* The ``language`` config value is now available in the HTML templates. Bugs fixed ---------- diff --git a/sphinx/builders/html.py b/sphinx/builders/html.py index 11931b61f..2aed9bc4a 100644 --- a/sphinx/builders/html.py +++ b/sphinx/builders/html.py @@ -337,6 +337,7 @@ class StandaloneHTMLBuilder(Builder): show_source = self.config.html_show_sourcelink, file_suffix = self.out_suffix, script_files = self.script_files, + language = self.config.language, css_files = self.css_files, sphinx_version = __version__, style = stylename, From 9df7b53782bd999387f33f43e9433a8a41bc75b6 Mon Sep 17 00:00:00 2001 From: Rob Ruana Date: Mon, 12 Jan 2015 17:08:51 -0500 Subject: [PATCH 14/40] Closes #1670: Fix napoleon handling of *args and **kwargs parameters --- sphinx/ext/napoleon/docstring.py | 12 ++++++-- tests/test_ext_napoleon_docstring.py | 42 ++++++++++++++++++++++++++++ 2 files changed, 52 insertions(+), 2 deletions(-) diff --git a/sphinx/ext/napoleon/docstring.py b/sphinx/ext/napoleon/docstring.py index 4902c3099..eedc3687d 100644 --- a/sphinx/ext/napoleon/docstring.py +++ b/sphinx/ext/napoleon/docstring.py @@ -23,8 +23,9 @@ from sphinx.util.pycompat import UnicodeMixin _directive_regex = re.compile(r'\.\. \S+::') -_google_untyped_arg_regex = re.compile(r'\s*(\w+)\s*:\s*(.*)') -_google_typed_arg_regex = re.compile(r'\s*(\w+)\s*\(\s*(.+?)\s*\)\s*:\s*(.*)') +_google_untyped_arg_regex = re.compile(r'\s*(\*?\*?\w+)\s*:\s*(.*)') +_google_typed_arg_regex = re.compile(r'\s*(\*?\*?\w+)\s*\(\s*(.+?)\s*\)\s*:' + r'\s*(.*)') class GoogleDocstring(UnicodeMixin): @@ -90,6 +91,7 @@ class GoogleDocstring(UnicodeMixin): :returns: Description of return value. :rtype: str + """ def __init__(self, docstring, config=None, app=None, what='', name='', @@ -215,6 +217,11 @@ class GoogleDocstring(UnicodeMixin): _name = match.group(1) _desc = match.group(2) + if _name[:2] == '**': + _name = r'\*\*'+_name[2:] + elif _name[:1] == '*': + _name = r'\*'+_name[1:] + if prefer_type and not _type: _type, _name = _name, _type indent = self._get_indent(line) + 1 @@ -663,6 +670,7 @@ class NumpyDocstring(GoogleDocstring): :returns: Description of return value. :rtype: str + Methods ------- diff --git a/tests/test_ext_napoleon_docstring.py b/tests/test_ext_napoleon_docstring.py index 853e73624..84e55840a 100644 --- a/tests/test_ext_napoleon_docstring.py +++ b/tests/test_ext_napoleon_docstring.py @@ -155,6 +155,26 @@ class GoogleDocstringTest(BaseDocstringTest): :returns: Extended description of return value""" + ), ( + """ + Single line summary + + Args: + arg1(str):Extended + description of arg1 + *args: Variable length argument list. + **kwargs: Arbitrary keyword arguments. + """, + """ + Single line summary + + :Parameters: * **arg1** (*str*) -- + Extended + description of arg1 + * **\\*args** -- + Variable length argument list. + * **\\*\\*kwargs** -- + Arbitrary keyword arguments.""" )] def test_docstrings(self): @@ -335,6 +355,28 @@ class NumpyDocstringTest(BaseDocstringTest): :returns: *str* -- Extended description of return value""" + ), ( + """ + Single line summary + + Parameters + ---------- + arg1:str + Extended description of arg1 + *args: + Variable length argument list. + **kwargs: + Arbitrary keyword arguments. + """, + """ + Single line summary + + :Parameters: * **arg1** (*str*) -- + Extended description of arg1 + * ***args** -- + Variable length argument list. + * ****kwargs** -- + Arbitrary keyword arguments.""" )] def test_docstrings(self): From ab546acef0f88fd4aa5132e8cbaa45a99e55624e Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Thu, 15 Jan 2015 08:26:40 +0100 Subject: [PATCH 15/40] #1674: do not crash if module.__all__ is not according to spec --- CHANGES | 1 + sphinx/ext/autodoc.py | 9 +++++++++ 2 files changed, 10 insertions(+) diff --git a/CHANGES b/CHANGES index 7a479629c..21491825f 100644 --- a/CHANGES +++ b/CHANGES @@ -16,6 +16,7 @@ Bugs fixed ---------- * LaTeX writer now generates correct markup for cells spanning multiple rows. +* #1674: Do not crash if a module's ``__all__`` is not a list of strings. Release 1.3b2 (released Dec 5, 2014) diff --git a/sphinx/ext/autodoc.py b/sphinx/ext/autodoc.py index 7c2f35f4e..ba4619e7c 100644 --- a/sphinx/ext/autodoc.py +++ b/sphinx/ext/autodoc.py @@ -879,6 +879,15 @@ class ModuleDocumenter(Documenter): return True, safe_getmembers(self.object) else: memberlist = self.object.__all__ + # Sometimes __all__ is broken... + if not isinstance(memberlist, (list, tuple)) or not \ + all(isinstance(entry, str) for entry in memberlist): + self.directive.warn( + '__all__ should be a list of strings, not %r ' + '(in module %s) -- ignoring __all__' % + (memberlist, self.fullname)) + # fall back to all members + return True, safe_getmembers(self.object) else: memberlist = self.options.members or [] ret = [] From 5bee0aac0c094261204630f8a75a1dcdf71f4cfa Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Thu, 15 Jan 2015 08:26:40 +0100 Subject: [PATCH 16/40] #1674: do not crash if module.__all__ is not according to spec --- CHANGES | 1 + sphinx/ext/autodoc.py | 9 +++++++++ 2 files changed, 10 insertions(+) diff --git a/CHANGES b/CHANGES index 921c099c3..925422262 100644 --- a/CHANGES +++ b/CHANGES @@ -26,6 +26,7 @@ Bugs fixed * #1585: Autosummary of modules broken in Sphinx-1.2.3. * #1610: Sphinx cause AttributeError when MeCab search option is enabled and python-mecab is not installed. +* #1674: Do not crash if a module's ``__all__`` is not a list of strings. Release 1.2.3 (released Sep 1, 2014) diff --git a/sphinx/ext/autodoc.py b/sphinx/ext/autodoc.py index c47d1ef0f..1d651d495 100644 --- a/sphinx/ext/autodoc.py +++ b/sphinx/ext/autodoc.py @@ -828,6 +828,15 @@ class ModuleDocumenter(Documenter): return True, safe_getmembers(self.object) else: memberlist = self.object.__all__ + # Sometimes __all__ is broken... + if not isinstance(memberlist, (list, tuple)) or not \ + all(isinstance(entry, str) for entry in memberlist): + self.directive.warn( + '__all__ should be a list of strings, not %r ' + '(in module %s) -- ignoring __all__' % + (memberlist, self.fullname)) + # fall back to all members + return True, safe_getmembers(self.object) else: memberlist = self.options.members or [] ret = [] From 28683a36c4a128e602f35622bb3b0fb56d52f313 Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Thu, 15 Jan 2015 08:41:18 +0100 Subject: [PATCH 17/40] Closes #1673: fix crashes with nitpick_ignore and :doc: references. --- CHANGES | 1 + sphinx/environment.py | 3 ++- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/CHANGES b/CHANGES index 925422262..3ee093428 100644 --- a/CHANGES +++ b/CHANGES @@ -27,6 +27,7 @@ Bugs fixed * #1610: Sphinx cause AttributeError when MeCab search option is enabled and python-mecab is not installed. * #1674: Do not crash if a module's ``__all__`` is not a list of strings. +* #1673: Fix crashes with :confval:`nitpick_ignore` and ``:doc:`` references. Release 1.2.3 (released Sep 1, 2014) diff --git a/sphinx/environment.py b/sphinx/environment.py index d83243215..5c783808c 100644 --- a/sphinx/environment.py +++ b/sphinx/environment.py @@ -1406,7 +1406,8 @@ class BuildEnvironment: if (dtype, target) in self._nitpick_ignore: warn = False # for "std" types also try without domain name - if domain.name == 'std' and (typ, target) in self._nitpick_ignore: + if (not domain or domain.name == 'std') and \ + (typ, target) in self._nitpick_ignore: warn = False if not warn: return From e722258079ad099b97578441ce1809b6089c9964 Mon Sep 17 00:00:00 2001 From: shimizukawa Date: Sat, 17 Jan 2015 14:37:09 +0900 Subject: [PATCH 18/40] Fix: on windows, make-mode didn't work on Win32 platform if sphinx was invoked as `python sphinx-build.py`. --- CHANGES | 2 ++ sphinx/make_mode.py | 11 ++++++++--- 2 files changed, 10 insertions(+), 3 deletions(-) diff --git a/CHANGES b/CHANGES index 101340d7b..f6c5e5867 100644 --- a/CHANGES +++ b/CHANGES @@ -17,6 +17,8 @@ Bugs fixed * LaTeX writer now generates correct markup for cells spanning multiple rows. * #1674: Do not crash if a module's ``__all__`` is not a list of strings. +* On windows, make-mode didn't work on Win32 platform if sphinx was invoked as + ``python sphinx-build.py``. Release 1.3b2 (released Dec 5, 2014) diff --git a/sphinx/make_mode.py b/sphinx/make_mode.py index bc32c4a24..8e0d196f4 100644 --- a/sphinx/make_mode.py +++ b/sphinx/make_mode.py @@ -251,13 +251,18 @@ class Make(object): doctreedir = self.builddir_join('doctrees') orig_cmd = sys.argv[0] - if orig_cmd.endswith('.exe'): + if sys.platform == 'win32' and orig_cmd.endswith('.exe'): + # win32: 'sphinx-build.exe' cmd = [orig_cmd] - elif sys.platform == 'win32': + elif sys.platform == 'win32' and os.path.splitext(orig_cmd)[1] == '': + # win32: 'sphinx-build' without extension cmd = [orig_cmd + '.exe'] - else: # ex. 'sphinx-build' or 'sphinx-build.py' + else: + # win32: 'sphinx-build.py' + # linux, mac: 'sphinx-build' or 'sphinx-build.py' cmd = [sys.executable, orig_cmd] + print(cmd) return call(cmd + ['-b', builder] + opts + ['-d', doctreedir, self.srcdir, self.builddir_join(builder)]) From 668fa9935bf0e2f024cd0a2dedd7fe9e63bd0ae4 Mon Sep 17 00:00:00 2001 From: shimizukawa Date: Sat, 17 Jan 2015 14:38:14 +0900 Subject: [PATCH 19/40] remove debug print. sorry :( --- sphinx/make_mode.py | 1 - 1 file changed, 1 deletion(-) diff --git a/sphinx/make_mode.py b/sphinx/make_mode.py index 8e0d196f4..bb9a7d499 100644 --- a/sphinx/make_mode.py +++ b/sphinx/make_mode.py @@ -262,7 +262,6 @@ class Make(object): # linux, mac: 'sphinx-build' or 'sphinx-build.py' cmd = [sys.executable, orig_cmd] - print(cmd) return call(cmd + ['-b', builder] + opts + ['-d', doctreedir, self.srcdir, self.builddir_join(builder)]) From 3c872e66a4e2482eb3888052194c22562ee011a8 Mon Sep 17 00:00:00 2001 From: shimizukawa Date: Sat, 17 Jan 2015 16:01:53 +0900 Subject: [PATCH 20/40] Fixes #1686: ifconfig directive doesn't care about default config values. --- CHANGES | 1 + sphinx/ext/ifconfig.py | 3 ++- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/CHANGES b/CHANGES index 3ee093428..3ed21bee8 100644 --- a/CHANGES +++ b/CHANGES @@ -28,6 +28,7 @@ Bugs fixed python-mecab is not installed. * #1674: Do not crash if a module's ``__all__`` is not a list of strings. * #1673: Fix crashes with :confval:`nitpick_ignore` and ``:doc:`` references. +* #1686: ifconfig directive doesn't care about default config values. Release 1.2.3 (released Sep 1, 2014) diff --git a/sphinx/ext/ifconfig.py b/sphinx/ext/ifconfig.py index 195783755..a675b9796 100644 --- a/sphinx/ext/ifconfig.py +++ b/sphinx/ext/ifconfig.py @@ -48,7 +48,8 @@ class IfConfig(Directive): def process_ifconfig_nodes(app, doctree, docname): - ns = app.config.__dict__.copy() + ns = {k: app.config[k] for k in app.config.values} + ns.update(app.config.__dict__.copy()) ns['builder'] = app.builder.name for node in doctree.traverse(ifconfig): try: From 14b4a56bec5034eca657cc6469d0403ace3c5862 Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Sat, 17 Jan 2015 11:22:40 +0100 Subject: [PATCH 21/40] Closes #1680: fix botched error check for nonexisting environment file --- sphinx/application.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sphinx/application.py b/sphinx/application.py index 8012d2409..5e2aa5195 100644 --- a/sphinx/application.py +++ b/sphinx/application.py @@ -188,7 +188,7 @@ class Sphinx(object): self.env.domains[domain] = self.domains[domain](self.env) self.info('done') except Exception, err: - if type(err) is IOError and err.errno == ENOENT: + if isinstance(err, IOError) and err.errno == ENOENT: self.info('not yet created') else: self.info('failed: %s' % err) From f2b910a7b2eb330b8c4efaa072201e8fec107f27 Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Sat, 17 Jan 2015 11:22:40 +0100 Subject: [PATCH 22/40] Closes #1680: fix botched error check for nonexisting environment file --- sphinx/application.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sphinx/application.py b/sphinx/application.py index 310e21a57..984b28e64 100644 --- a/sphinx/application.py +++ b/sphinx/application.py @@ -218,7 +218,7 @@ class Sphinx(object): self.env.domains[domain] = self.domains[domain](self.env) self.info('done') except Exception as err: - if type(err) is IOError and err.errno == ENOENT: + if isinstance(err, IOError) and err.errno == ENOENT: self.info('not yet created') else: self.info('failed: %s' % err) From b563fa44f2d807f6c077ee9434abe5e92a9dc476 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Sun, 18 Jan 2015 15:32:01 +0900 Subject: [PATCH 23/40] Fix #1620: Use VerbatimBorderColor to add frame to code-block in LaTeX --- sphinx/highlighting.py | 4 +--- sphinx/texinputs/sphinx.sty | 4 ++-- tests/test_markup.py | 2 +- 3 files changed, 4 insertions(+), 6 deletions(-) diff --git a/sphinx/highlighting.py b/sphinx/highlighting.py index 58365b35c..22f53a45b 100644 --- a/sphinx/highlighting.py +++ b/sphinx/highlighting.py @@ -96,7 +96,7 @@ class PygmentsBridge(object): source = source.translate(escape_hl_chars) # then, escape all characters nonrepresentable in LaTeX source = source.translate(tex_hl_escape_map_new) - return '\\begin{Verbatim}[frame=single,commandchars=\\\\\\{\\}]\n' + \ + return '\\begin{Verbatim}[commandchars=\\\\\\{\\}]\n' + \ source + '\\end{Verbatim}\n' def try_parse(self, src): @@ -190,8 +190,6 @@ class PygmentsBridge(object): if self.dest == 'html': return hlsource else: - hlsource = re.sub(r'(?<=\\begin{Verbatim}\[)(?=commandchars)', - r'frame=single,', hlsource) if not isinstance(hlsource, text_type): # Py2 / Pygments < 1.6 hlsource = hlsource.decode() return hlsource.translate(tex_hl_escape_map_new) diff --git a/sphinx/texinputs/sphinx.sty b/sphinx/texinputs/sphinx.sty index 444b0373b..b28b204bc 100644 --- a/sphinx/texinputs/sphinx.sty +++ b/sphinx/texinputs/sphinx.sty @@ -39,10 +39,10 @@ \definecolor{TitleColor}{rgb}{0.126,0.263,0.361} \definecolor{InnerLinkColor}{rgb}{0.208,0.374,0.486} \definecolor{OuterLinkColor}{rgb}{0.216,0.439,0.388} -% Redefine these colors to something not white if you want to have colored +% Redefine these colors to something if you want to have colored % background and border for code examples. \definecolor{VerbatimColor}{rgb}{1,1,1} -\definecolor{VerbatimBorderColor}{rgb}{1,1,1} +\definecolor{VerbatimBorderColor}{rgb}{0,0,0} % Uncomment these two lines to ignore the paper size and make the page % size more like a typical published manual. diff --git a/tests/test_markup.py b/tests/test_markup.py index 2d915fcb1..d282d236d 100644 --- a/tests/test_markup.py +++ b/tests/test_markup.py @@ -136,7 +136,7 @@ def test_latex_escaping(): r'\(\Gamma\)\textbackslash{}\(\infty\)\$') # in verbatim code fragments yield (verify, u'::\n\n @Γ\\∞${}', None, - u'\\begin{Verbatim}[frame=single,commandchars=\\\\\\{\\}]\n' + u'\\begin{Verbatim}[commandchars=\\\\\\{\\}]\n' u'@\\(\\Gamma\\)\\PYGZbs{}\\(\\infty\\)\\PYGZdl{}\\PYGZob{}\\PYGZcb{}\n' u'\\end{Verbatim}') # in URIs From 198731f154b8236171d75bcd4547e6c41f6ab49f Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Sun, 18 Jan 2015 16:08:46 +0900 Subject: [PATCH 24/40] Update CHANGES for b563fa4 --- CHANGES | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGES b/CHANGES index 10c2587c1..b298d6b58 100644 --- a/CHANGES +++ b/CHANGES @@ -17,6 +17,7 @@ Bugs fixed * LaTeX writer now generates correct markup for cells spanning multiple rows. * #1674: Do not crash if a module's ``__all__`` is not a list of strings. +* #1629: Use VerbatimBorderColor to add frame to code-block in LaTeX * On windows, make-mode didn't work on Win32 platform if sphinx was invoked as ``python sphinx-build.py``. From 2b6f7f4afe8692d413cf91b0febd2525fa0c6a0d Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Mon, 19 Jan 2015 19:50:05 +0100 Subject: [PATCH 25/40] Closes #1687: for linkcheck purposes, HTTP 401 Unauthorized is working. --- CHANGES | 1 + sphinx/builders/linkcheck.py | 17 ++++++++++++----- 2 files changed, 13 insertions(+), 5 deletions(-) diff --git a/CHANGES b/CHANGES index b298d6b58..a3088e695 100644 --- a/CHANGES +++ b/CHANGES @@ -20,6 +20,7 @@ Bugs fixed * #1629: Use VerbatimBorderColor to add frame to code-block in LaTeX * On windows, make-mode didn't work on Win32 platform if sphinx was invoked as ``python sphinx-build.py``. +* #1687: linkcheck now treats 401 Unauthorized responses as "working". Release 1.3b2 (released Dec 5, 2014) diff --git a/sphinx/builders/linkcheck.py b/sphinx/builders/linkcheck.py index 2a2d40420..9da7818dc 100644 --- a/sphinx/builders/linkcheck.py +++ b/sphinx/builders/linkcheck.py @@ -122,7 +122,7 @@ class CheckExternalLinksBuilder(Builder): elif not (uri[0:5] == 'http:' or uri[0:6] == 'https:'): return 'local', '', 0 elif uri in self.good: - return 'working', '', 0 + return 'working', 'old', 0 elif uri in self.broken: return 'broken', self.broken[uri], 0 elif uri in self.redirected: @@ -166,13 +166,20 @@ class CheckExternalLinksBuilder(Builder): req = Request(req_url) f = opener.open(req, **kwargs) f.close() - + except HTTPError as err: + if err.code == 401: + # We'll take "Unauthorized" as working. + self.good.add(uri) + return 'working', ' - unauthorized', 0 + else: + self.broken[uri] = str(err) + return 'broken', str(err), 0 except Exception as err: self.broken[uri] = str(err) return 'broken', str(err), 0 if f.url.rstrip('/') == req_url.rstrip('/'): self.good.add(uri) - return 'working', 'new', 0 + return 'working', '', 0 else: new_url = f.url if hash: @@ -192,7 +199,7 @@ class CheckExternalLinksBuilder(Builder): uri, docname, lineno, status, info, code = result if status == 'unchecked': return - if status == 'working' and info != 'new': + if status == 'working' and info == 'old': return if lineno: self.info('(line %4d) ' % lineno, nonl=1) @@ -202,7 +209,7 @@ class CheckExternalLinksBuilder(Builder): self.info(darkgray('-local- ') + uri) self.write_entry('local', docname, lineno, uri) elif status == 'working': - self.info(darkgreen('ok ') + uri) + self.info(darkgreen('ok ') + uri + info) elif status == 'broken': self.info(red('broken ') + uri + red(' - ' + info)) self.write_entry('broken', docname, lineno, uri + ': ' + info) From 9ee14db10204fe37df32939331ed67bc26000ac7 Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Sun, 25 Jan 2015 10:59:09 +0100 Subject: [PATCH 26/40] Fixes #1688: actually emit warnings when doing parallel build --- sphinx/builders/__init__.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/sphinx/builders/__init__.py b/sphinx/builders/__init__.py index abc8fc74c..28b0706ca 100644 --- a/sphinx/builders/__init__.py +++ b/sphinx/builders/__init__.py @@ -388,6 +388,9 @@ class Builder(object): self.info(bold('waiting for workers...')) tasks.join() + for warning in warnings: + self.warn(*warning) + def prepare_writing(self, docnames): """A place where you can add logic before :meth:`write_doc` is run""" raise NotImplementedError From 23c0d3d42ab24746f24765d76bea11bf5c57ad53 Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Sun, 25 Jan 2015 11:07:55 +0100 Subject: [PATCH 27/40] Fixes #1690: toctrees with ``glob`` option now can also contain entries for single documents with explicit title. --- CHANGES | 2 ++ sphinx/directives/other.py | 25 +++++++++++++------------ 2 files changed, 15 insertions(+), 12 deletions(-) diff --git a/CHANGES b/CHANGES index a3088e695..e53a4f04c 100644 --- a/CHANGES +++ b/CHANGES @@ -21,6 +21,8 @@ Bugs fixed * On windows, make-mode didn't work on Win32 platform if sphinx was invoked as ``python sphinx-build.py``. * #1687: linkcheck now treats 401 Unauthorized responses as "working". +* #1690: toctrees with ``glob`` option now can also contain entries for single + documents with explicit title. Release 1.3b2 (released Dec 5, 2014) diff --git a/sphinx/directives/other.py b/sphinx/directives/other.py index 948de4fee..3e9747e83 100644 --- a/sphinx/directives/other.py +++ b/sphinx/directives/other.py @@ -62,7 +62,18 @@ class TocTree(Directive): for entry in self.content: if not entry: continue - if not glob: + if glob and ('*' in entry or '?' in entry or '[' in entry): + patname = docname_join(env.docname, entry) + docnames = sorted(patfilter(all_docnames, patname)) + for docname in docnames: + all_docnames.remove(docname) # don't include it again + entries.append((None, docname)) + includefiles.append(docname) + if not docnames: + ret.append(self.state.document.reporter.warning( + 'toctree glob pattern %r didn\'t match any documents' + % entry, line=self.lineno)) + else: # look for explicit titles ("Some Title ") m = explicit_title_re.match(entry) if m: @@ -85,19 +96,9 @@ class TocTree(Directive): 'document %r' % docname, line=self.lineno)) env.note_reread() else: + all_docnames.remove(docname) entries.append((title, docname)) includefiles.append(docname) - else: - patname = docname_join(env.docname, entry) - docnames = sorted(patfilter(all_docnames, patname)) - for docname in docnames: - all_docnames.remove(docname) # don't include it again - entries.append((None, docname)) - includefiles.append(docname) - if not docnames: - ret.append(self.state.document.reporter.warning( - 'toctree glob pattern %r didn\'t match any documents' - % entry, line=self.lineno)) subnode = addnodes.toctree() subnode['parent'] = env.docname # entries contains all entries (self references, external links etc.) From d28b6ef2c3bc26d2eb2caa32ea8eeac3cdc77e77 Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Sun, 25 Jan 2015 11:22:25 +0100 Subject: [PATCH 28/40] Fix traceback with duplicate toctree entries. --- sphinx/directives/other.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sphinx/directives/other.py b/sphinx/directives/other.py index 3e9747e83..74938ba09 100644 --- a/sphinx/directives/other.py +++ b/sphinx/directives/other.py @@ -96,7 +96,7 @@ class TocTree(Directive): 'document %r' % docname, line=self.lineno)) env.note_reread() else: - all_docnames.remove(docname) + all_docnames.discard(docname) entries.append((title, docname)) includefiles.append(docname) subnode = addnodes.toctree() From 398a207b75931b0178da4dbaa759b66e470ca7fc Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Sun, 25 Jan 2015 16:07:18 +0100 Subject: [PATCH 29/40] Closes #1642: fix only one search result appearing in Chrome. --- CHANGES | 1 + sphinx/themes/basic/static/searchtools.js_t | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/CHANGES b/CHANGES index 3ed21bee8..ea2406945 100644 --- a/CHANGES +++ b/CHANGES @@ -29,6 +29,7 @@ Bugs fixed * #1674: Do not crash if a module's ``__all__`` is not a list of strings. * #1673: Fix crashes with :confval:`nitpick_ignore` and ``:doc:`` references. * #1686: ifconfig directive doesn't care about default config values. +* #1642: Fix only one search result appearing in Chrome. Release 1.2.3 (released Sep 1, 2014) diff --git a/sphinx/themes/basic/static/searchtools.js_t b/sphinx/themes/basic/static/searchtools.js_t index 90f7a655a..38515a99e 100644 --- a/sphinx/themes/basic/static/searchtools.js_t +++ b/sphinx/themes/basic/static/searchtools.js_t @@ -259,7 +259,7 @@ var Search = { dataType: "text", complete: function(jqxhr, textstatus) { var data = jqxhr.responseText; - if (data !== '') { + if (data !== '' && data !== undefined) { listItem.append(Search.makeSearchSummary(data, searchterms, hlterms)); } Search.output.append(listItem); From accb32ff0726dbc1eb5ed92a9c0cf65a6c59fed1 Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Sun, 25 Jan 2015 16:13:04 +0100 Subject: [PATCH 30/40] The ``env-updated`` event can now return a value, which is interpreted as an iterable of additional docnames that need to be rewritten. (reference: #1683) --- CHANGES | 2 ++ doc/extdev/appapi.rst | 7 +++++++ sphinx/environment.py | 8 ++++++-- 3 files changed, 15 insertions(+), 2 deletions(-) diff --git a/CHANGES b/CHANGES index bb8f89df0..1e00780b4 100644 --- a/CHANGES +++ b/CHANGES @@ -11,6 +11,8 @@ Features added * Added ``highlight_options`` configuration value. * The ``language`` config value is now available in the HTML templates. +* The ``env-updated`` event can now return a value, which is interpreted + as an iterable of additional docnames that need to be rewritten. Bugs fixed ---------- diff --git a/doc/extdev/appapi.rst b/doc/extdev/appapi.rst index 475848065..c2ee4cc86 100644 --- a/doc/extdev/appapi.rst +++ b/doc/extdev/appapi.rst @@ -530,8 +530,15 @@ handlers to the events. Example: Emitted when the :meth:`update` method of the build environment has completed, that is, the environment and all doctrees are now up-to-date. + You can return an iterable of docnames from the handler. These documents + will then be considered updated, and will be (re-)written during the writing + phase. + .. versionadded:: 0.5 + .. versionchanged:: 1.3 + The handlers' return value is now used. + .. event:: html-collect-pages (app) Emitted when the HTML builder is starting to write non-document pages. You diff --git a/sphinx/environment.py b/sphinx/environment.py index 414fb4f29..bc12afacc 100644 --- a/sphinx/environment.py +++ b/sphinx/environment.py @@ -589,8 +589,12 @@ class BuildEnvironment: self.doc2path(config.master_doc)) self.app = None - app.emit('env-updated', self) - return docnames + + for retval in app.emit('env-updated', self): + if retval is not None: + docnames.extend(retval) + + return sorted(docnames) def _read_serial(self, docnames, app): for docname in app.status_iterator(docnames, 'reading sources... ', From 309e0169b0c3c52ffb9ca3c14bc5a64504ff1923 Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Sun, 25 Jan 2015 16:25:32 +0100 Subject: [PATCH 31/40] Adapt test after env-updated change. --- tests/test_environment.py | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/tests/test_environment.py b/tests/test_environment.py index df8b11dfe..1e639aeb6 100644 --- a/tests/test_environment.py +++ b/tests/test_environment.py @@ -106,13 +106,12 @@ def test_env_read_docs(): assert len(read_docnames) > 2 and read_docnames == sorted(read_docnames) def on_env_read_docs_2(app, env, docnames): - docnames.reverse() + docnames.remove('images') app.connect('env-before-read-docs', on_env_read_docs_2) read_docnames = env.update(app.config, app.srcdir, app.doctreedir, app) - reversed_read_docnames = sorted(read_docnames, reverse=True) - assert len(read_docnames) > 2 and read_docnames == reversed_read_docnames + assert len(read_docnames) == 2 def test_object_inventory(): From 2ebfd1dd30764ccd0f63ef8d1ac44180d2f62a67 Mon Sep 17 00:00:00 2001 From: Matt Hickford Date: Sun, 25 Jan 2015 20:35:00 +0000 Subject: [PATCH 32/40] Fix broken link to Mathjax Consistent with http://docs.mathjax.org/en/latest/start.html#secure-access-to-the-cdn --- sphinx/ext/mathjax.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sphinx/ext/mathjax.py b/sphinx/ext/mathjax.py index edabbabb0..26d1e2aa1 100644 --- a/sphinx/ext/mathjax.py +++ b/sphinx/ext/mathjax.py @@ -64,7 +64,7 @@ def setup(app): # more information for mathjax secure url is here: # http://docs.mathjax.org/en/latest/start.html#secure-access-to-the-cdn app.add_config_value('mathjax_path', - 'https://c328740.ssl.cf1.rackcdn.com/mathjax/latest/MathJax.js?' + 'https://cdn.mathjax.org/mathjax/latest/MathJax.js?' 'config=TeX-AMS-MML_HTMLorMML', False) app.add_config_value('mathjax_inline', [r'\(', r'\)'], 'html') app.add_config_value('mathjax_display', [r'\[', r'\]'], 'html') From ffe331d8223298bfb69f5e929628605e854f8127 Mon Sep 17 00:00:00 2001 From: Yclept Nemo Date: Sun, 25 Jan 2015 16:12:38 -0500 Subject: [PATCH 33/40] Class "BuildDoc": support "copyright" Adds "author", "date", and "copyright" options. If "copyright" is not provided but either "author" or "date" are, generate the copyright string using them. --- sphinx/setup_command.py | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/sphinx/setup_command.py b/sphinx/setup_command.py index 7232b9ca1..dfe3ed2f1 100644 --- a/sphinx/setup_command.py +++ b/sphinx/setup_command.py @@ -77,6 +77,10 @@ class BuildDoc(Command): ('today=', None, 'How to format the current date, used as the ' 'replacement for |today|'), ('link-index', 'i', 'Link index.html to the master doc'), + ('copyright', None, 'The copyright string'), + ('author', None, 'The documented project\'s author'), + ('date', None, 'Dates of first publication and major revisions'), + ] boolean_options = ['fresh-env', 'all-files', 'link-index'] @@ -91,6 +95,9 @@ class BuildDoc(Command): self.today = '' self.config_dir = None self.link_index = False + self.copyright = '' + self.author = '' + self.date = '' def _guess_source_dir(self): for guess in ('doc', 'docs'): @@ -135,6 +142,8 @@ class BuildDoc(Command): self.mkpath(self.doctree_dir) self.builder_target_dir = os.path.join(self.build_dir, self.builder) self.mkpath(self.builder_target_dir) + if not self.copyright and (self.author or self.date): + self.copyright = ", ".join((self.date, self.author)) def run(self): if not color_terminal(): @@ -152,6 +161,8 @@ class BuildDoc(Command): confoverrides['release'] = self.release if self.today: confoverrides['today'] = self.today + if self.copyright: + confoverrides['copyright'] = self.copyright app = Sphinx(self.source_dir, self.config_dir, self.builder_target_dir, self.doctree_dir, self.builder, confoverrides, status_stream, From fdad400ccd79ef62a73065f562d589f8e3851085 Mon Sep 17 00:00:00 2001 From: Yclept Nemo Date: Sun, 25 Jan 2015 17:04:11 -0500 Subject: [PATCH 34/40] BuildDoc: remove "author" and "date" options --- sphinx/setup_command.py | 7 ------- 1 file changed, 7 deletions(-) diff --git a/sphinx/setup_command.py b/sphinx/setup_command.py index dfe3ed2f1..748948e57 100644 --- a/sphinx/setup_command.py +++ b/sphinx/setup_command.py @@ -78,9 +78,6 @@ class BuildDoc(Command): 'replacement for |today|'), ('link-index', 'i', 'Link index.html to the master doc'), ('copyright', None, 'The copyright string'), - ('author', None, 'The documented project\'s author'), - ('date', None, 'Dates of first publication and major revisions'), - ] boolean_options = ['fresh-env', 'all-files', 'link-index'] @@ -96,8 +93,6 @@ class BuildDoc(Command): self.config_dir = None self.link_index = False self.copyright = '' - self.author = '' - self.date = '' def _guess_source_dir(self): for guess in ('doc', 'docs'): @@ -142,8 +137,6 @@ class BuildDoc(Command): self.mkpath(self.doctree_dir) self.builder_target_dir = os.path.join(self.build_dir, self.builder) self.mkpath(self.builder_target_dir) - if not self.copyright and (self.author or self.date): - self.copyright = ", ".join((self.date, self.author)) def run(self): if not color_terminal(): From d24bd73d0ce8071459a1056691a1934e1ca12194 Mon Sep 17 00:00:00 2001 From: Dmitry Shachnev Date: Wed, 28 Jan 2015 19:28:53 +0300 Subject: [PATCH 35/40] Remove non-determinism To enable packages using Sphinx to build reproducibly, its output needs to be the same from one build to another. Its output now strips memory references such as: <__main__.A at 0x7f68cb685710> In addition, various generated files (objects.inv, searchindex.js, translations) are now written with their keys in a determinstic order. Based on a patch by Chris Lamb . --- sphinx/builders/html.py | 7 ++++--- sphinx/ext/autodoc.py | 17 +++++++++++------ sphinx/search/__init__.py | 6 +++--- sphinx/util/inspect.py | 11 +++++++++-- sphinx/util/jsdump.py | 8 +++++--- 5 files changed, 32 insertions(+), 17 deletions(-) diff --git a/sphinx/builders/html.py b/sphinx/builders/html.py index 2aed9bc4a..093d2b416 100644 --- a/sphinx/builders/html.py +++ b/sphinx/builders/html.py @@ -17,7 +17,7 @@ import posixpath from os import path from hashlib import md5 -from six import iteritems, itervalues, text_type, string_types +from six import iteritems, text_type, string_types from six.moves import cPickle as pickle from docutils import nodes from docutils.io import DocTreeInput, StringOutput @@ -268,7 +268,8 @@ class StandaloneHTMLBuilder(Builder): # html_domain_indices can be False/True or a list of index names indices_config = self.config.html_domain_indices if indices_config: - for domain in itervalues(self.env.domains): + for domain_name in sorted(self.env.domains): + domain = self.env.domains[domain_name] for indexcls in domain.indices: indexname = '%s-%s' % (domain.name, indexcls.name) if isinstance(indices_config, list): @@ -817,7 +818,7 @@ class StandaloneHTMLBuilder(Builder): compressor = zlib.compressobj(9) for domainname, domain in iteritems(self.env.domains): for name, dispname, type, docname, anchor, prio in \ - domain.get_objects(): + sorted(domain.get_objects()): if anchor.endswith(name): # this can shorten the inventory by as much as 25% anchor = anchor[:-len(name)] + '$' diff --git a/sphinx/ext/autodoc.py b/sphinx/ext/autodoc.py index ba4619e7c..27cd54f93 100644 --- a/sphinx/ext/autodoc.py +++ b/sphinx/ext/autodoc.py @@ -30,7 +30,7 @@ from sphinx.application import ExtensionError from sphinx.util.nodes import nested_parse_with_titles from sphinx.util.compat import Directive from sphinx.util.inspect import getargspec, isdescriptor, safe_getmembers, \ - safe_getattr, safe_repr, is_builtin_class_method + safe_getattr, object_description, is_builtin_class_method from sphinx.util.docstrings import prepare_docstring @@ -243,6 +243,11 @@ def between(marker, what=None, keepempty=False, exclude=False): return process +def formatargspec(*argspec): + return inspect.formatargspec(*argspec, + formatvalue=lambda x: '=' + object_description(x)) + + class Documenter(object): """ A Documenter knows how to autodocument a single object type. When @@ -1054,7 +1059,7 @@ class FunctionDocumenter(DocstringSignatureMixin, ModuleLevelDocumenter): argspec = getargspec(self.object.__init__) if argspec[0]: del argspec[0][0] - args = inspect.formatargspec(*argspec) + args = formatargspec(*argspec) # escape backslashes for reST args = args.replace('\\', '\\\\') return args @@ -1109,7 +1114,7 @@ class ClassDocumenter(DocstringSignatureMixin, ModuleLevelDocumenter): return None if argspec[0] and argspec[0][0] in ('cls', 'self'): del argspec[0][0] - return inspect.formatargspec(*argspec) + return formatargspec(*argspec) def format_signature(self): if self.doc_as_attr: @@ -1220,7 +1225,7 @@ class DataDocumenter(ModuleLevelDocumenter): sourcename = self.get_sourcename() if not self.options.annotation: try: - objrepr = safe_repr(self.object) + objrepr = object_description(self.object) except ValueError: pass else: @@ -1276,7 +1281,7 @@ class MethodDocumenter(DocstringSignatureMixin, ClassLevelDocumenter): argspec = getargspec(self.object) if argspec[0] and argspec[0][0] in ('cls', 'self'): del argspec[0][0] - args = inspect.formatargspec(*argspec) + args = formatargspec(*argspec) # escape backslashes for reST args = args.replace('\\', '\\\\') return args @@ -1333,7 +1338,7 @@ class AttributeDocumenter(DocstringStripSignatureMixin, ClassLevelDocumenter): if not self.options.annotation: if not self._datadescriptor: try: - objrepr = safe_repr(self.object) + objrepr = object_description(self.object) except ValueError: pass else: diff --git a/sphinx/search/__init__.py b/sphinx/search/__init__.py index d6be150d0..ebba8a371 100644 --- a/sphinx/search/__init__.py +++ b/sphinx/search/__init__.py @@ -313,13 +313,13 @@ class IndexBuilder(object): if fn in fn2index: rv[k] = fn2index[fn] else: - rv[k] = [fn2index[fn] for fn in v if fn in fn2index] + rv[k] = sorted([fn2index[fn] for fn in v if fn in fn2index]) return rvs def freeze(self): """Create a usable data structure for serializing.""" - filenames = list(self._titles.keys()) - titles = list(self._titles.values()) + filenames = sorted(self._titles.keys()) + titles = sorted(self._titles.values()) fn2index = dict((f, i) for (i, f) in enumerate(filenames)) terms, title_terms = self.get_terms(fn2index) diff --git a/sphinx/util/inspect.py b/sphinx/util/inspect.py index 8cbf59bde..d2d5dd0a3 100644 --- a/sphinx/util/inspect.py +++ b/sphinx/util/inspect.py @@ -9,6 +9,8 @@ :license: BSD, see LICENSE for details. """ +import re + # this imports the standard library inspect module without resorting to # relatively import this module inspect = __import__('inspect') @@ -18,6 +20,8 @@ from six.moves import builtins from sphinx.util import force_decode +memory_address_re = re.compile(r' at 0x[0-9a-f]{8,16}(?=>$)') + if PY3: from functools import partial @@ -123,14 +127,17 @@ def safe_getmembers(object, predicate=None, attr_getter=safe_getattr): return results -def safe_repr(object): +def object_description(object): """A repr() implementation that returns text safe to use in reST context.""" try: s = repr(object) except Exception: raise ValueError if isinstance(s, binary_type): - return force_decode(s, None).replace('\n', ' ') + s = force_decode(s, None) + # Strip non-deterministic memory addresses such as + # ``<__main__.A at 0x7f68cb685710>`` + s = memory_address_re.sub('', s) return s.replace('\n', ' ') diff --git a/sphinx/util/jsdump.py b/sphinx/util/jsdump.py index e75648a6b..49813672d 100644 --- a/sphinx/util/jsdump.py +++ b/sphinx/util/jsdump.py @@ -89,11 +89,13 @@ def dumps(obj, key=False): elif isinstance(obj, integer_types + (float,)): return str(obj) elif isinstance(obj, dict): - return '{%s}' % ','.join('%s:%s' % ( + return '{%s}' % ','.join(sorted('%s:%s' % ( dumps(key, True), dumps(value) - ) for key, value in iteritems(obj)) - elif isinstance(obj, (tuple, list, set)): + ) for key, value in iteritems(obj))) + elif isinstance(obj, set): + return '[%s]' % ','.join(sorted(dumps(x) for x in obj)) + elif isinstance(obj, (tuple, list)): return '[%s]' % ','.join(dumps(x) for x in obj) elif isinstance(obj, string_types): return encode_string(obj) From 927e84dd638ebe46590b5fc9d68d209458a25b72 Mon Sep 17 00:00:00 2001 From: Yclept Nemo Date: Thu, 29 Jan 2015 12:58:12 -0500 Subject: [PATCH 36/40] Fix sphinx.ext.inheritance_diagram on python 3 --- sphinx/ext/inheritance_diagram.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sphinx/ext/inheritance_diagram.py b/sphinx/ext/inheritance_diagram.py index 7775305f5..05eb15895 100644 --- a/sphinx/ext/inheritance_diagram.py +++ b/sphinx/ext/inheritance_diagram.py @@ -186,7 +186,7 @@ class InheritanceGraph(object): for cls in classes: recurse(cls) - return all_classes.values() + return list(all_classes.values()) def class_name(self, cls, parts=0): """Given a class object, return a fully-qualified name. From 20546b17c0d56dc52f20dba3b971fd764e6fa2e0 Mon Sep 17 00:00:00 2001 From: Chris Lamb Date: Sat, 31 Jan 2015 20:21:21 +0000 Subject: [PATCH 37/40] Ensure genindex output is deterministic. See also Signed-off-by: Chris Lamb --- sphinx/environment.py | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/sphinx/environment.py b/sphinx/environment.py index bc12afacc..e07b5e1c8 100644 --- a/sphinx/environment.py +++ b/sphinx/environment.py @@ -14,6 +14,7 @@ import os import sys import time import types +import bisect import codecs import imghdr import string @@ -1800,7 +1801,8 @@ class BuildEnvironment: except NoUri: pass else: - entry[0].append((main, uri)) + # maintain links in sorted/deterministic order + bisect.insort(entry[0], (main, uri)) for fn, entries in iteritems(self.indexentries): # new entry types must be listed in directives/other.py! @@ -1838,8 +1840,10 @@ class BuildEnvironment: def keyfunc(entry, lcletters=string.ascii_lowercase + '_'): lckey = unicodedata.normalize('NFD', entry[0].lower()) if lckey[0:1] in lcletters: - return chr(127) + lckey - return lckey + lckey = chr(127) + lckey + # ensure a determinstic order *within* letters by also sorting on + # the entry itself + return (lckey, entry[0]) newlist = sorted(new.items(), key=keyfunc) if group_entries: From 53aa275bd3f6d88f49b22a526d228b7945fcf243 Mon Sep 17 00:00:00 2001 From: Rob Ruana Date: Mon, 2 Feb 2015 05:20:24 -0500 Subject: [PATCH 38/40] Update my info in AUTHORS from @RelentlessIdiot to @RobRuana --- AUTHORS | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/AUTHORS b/AUTHORS index 382b8c3f2..44050d48a 100644 --- a/AUTHORS +++ b/AUTHORS @@ -8,7 +8,7 @@ Other co-maintainers: * Takayuki Shimizukawa * Daniel Neuhäuser <@DasIch> * Jon Waltman <@jonwaltman> -* Rob Ruana <@RelentlessIdiot> +* Rob Ruana <@RobRuana> * Robert Lehmann <@lehmannro> * Roland Meister <@rolmei> From 5f0977ca30379f06868537f7ea3274d64ad2627c Mon Sep 17 00:00:00 2001 From: Jakob Lykke Andersen Date: Tue, 3 Feb 2015 09:18:18 +0100 Subject: [PATCH 39/40] C++, add support for 'const', 'volatile', etc. on the right-hand side of the type. --- sphinx/domains/cpp.py | 159 ++++++++++++++++++++++++--------------- tests/test_domain_cpp.py | 2 + 2 files changed, 100 insertions(+), 61 deletions(-) diff --git a/sphinx/domains/cpp.py b/sphinx/domains/cpp.py index d4455a222..7affc658d 100644 --- a/sphinx/domains/cpp.py +++ b/sphinx/domains/cpp.py @@ -688,11 +688,8 @@ class ASTParametersQualifiers(ASTBase): _add_text(signode, '= ' + text_type(self.initializer)) -class ASTDeclSpecs(ASTBase): - def __init__(self, outer, visibility, storage, inline, virtual, explicit, - constexpr, volatile, const, trailing): - self.outer = outer - self.visibility = visibility +class ASTDeclSpecsSimple(ASTBase): + def __init__(self, storage, inline, virtual, explicit, constexpr, volatile, const): self.storage = storage self.inline = inline self.virtual = virtual @@ -700,31 +697,9 @@ class ASTDeclSpecs(ASTBase): self.constexpr = constexpr self.volatile = volatile self.const = const - self.trailingTypeSpec = trailing - - @property - def name(self): - return self.trailingTypeSpec.name - - def get_id(self): - res = [] - if self.volatile: - res.append('V') - if self.const: - res.append('K') - res.append(self.trailingTypeSpec.get_id()) - return u''.join(res) - - def _print_visibility(self): - return (self.visibility and - not ( - self.outer in ('type', 'member', 'function') and - self.visibility == 'public')) def __unicode__(self): res = [] - if self._print_visibility(): - res.append(self.visibility) if self.storage: res.append(self.storage) if self.inline: @@ -739,21 +714,13 @@ class ASTDeclSpecs(ASTBase): res.append('volatile') if self.const: res.append('const') - if self.trailingTypeSpec: - res.append(text_type(self.trailingTypeSpec)) return u' '.join(res) - def describe_signature(self, signode, mode, env): - _verify_description_mode(mode) - modifiers = [] - + def describe_signature(self, modifiers): def _add(modifiers, text): if len(modifiers) > 0: modifiers.append(nodes.Text(' ')) modifiers.append(addnodes.desc_annotation(text, text)) - - if self._print_visibility(): - _add(modifiers, self.visibility) if self.storage: _add(modifiers, self.storage) if self.inline: @@ -768,13 +735,79 @@ class ASTDeclSpecs(ASTBase): _add(modifiers, 'volatile') if self.const: _add(modifiers, 'const') + +class ASTDeclSpecs(ASTBase): + def __init__(self, outer, visibility, leftSpecs, rightSpecs, trailing): + self.outer = outer + self.visibility = visibility + self.leftSpecs = leftSpecs + self.rightSpecs = rightSpecs + self.trailingTypeSpec = trailing + + @property + def name(self): + return self.trailingTypeSpec.name + + def get_id(self): + res = [] + if self.leftSpecs.volatile or self.rightSpecs.volatile: + res.append('V') + if self.leftSpecs.const or self.rightSpecs.volatile: + res.append('K') + res.append(self.trailingTypeSpec.get_id()) + return u''.join(res) + + def _print_visibility(self): + return (self.visibility and + not ( + self.outer in ('type', 'member', 'function') and + self.visibility == 'public')) + + def __unicode__(self): + res = [] + if self._print_visibility(): + res.append(self.visibility) + l = text_type(self.leftSpecs) + if len(l) > 0: + if len(res) > 0: + res.append(" ") + res.append(l) + if self.trailingTypeSpec: + if len(res) > 0: + res.append(" ") + res.append(text_type(self.trailingTypeSpec)) + r = text_type(self.rightSpecs) + if len(r) > 0: + if len(res) > 0: + res.append(" ") + res.append(r) + return "".join(res) + + def describe_signature(self, signode, mode, env): + _verify_description_mode(mode) + modifiers = [] + + def _add(modifiers, text): + if len(modifiers) > 0: + modifiers.append(nodes.Text(' ')) + modifiers.append(addnodes.desc_annotation(text, text)) + + if self._print_visibility(): + _add(modifiers, self.visibility) + self.leftSpecs.describe_signature(modifiers) + for m in modifiers: signode += m if self.trailingTypeSpec: if len(modifiers) > 0: signode += nodes.Text(' ') self.trailingTypeSpec.describe_signature(signode, mode, env) - + modifiers = [] + self.rightSpecs.describe_signature(modifiers) + if len(modifiers) > 0: + signode += nodes.Text(' ') + for m in modifiers: + signode += m class ASTPtrOpPtr(ASTBase): def __init__(self, volatile, const): @@ -952,7 +985,6 @@ class ASTType(ASTBase): signode += nodes.Text(' ') self.decl.describe_signature(signode, mode, env) - class ASTTypeWithInit(ASTBase): def __init__(self, type, init): self.objectType = None @@ -1337,20 +1369,8 @@ class DefinitionParser(object): args, volatile, const, refQual, exceptionSpec, override, final, initializer) - def _parse_decl_specs(self, outer, typed=True): - """ - visibility storage-class-specifier function-specifier "constexpr" - "volatile" "const" trailing-type-specifier - - storage-class-specifier -> "static" (only for member_object and - function_object) - - function-specifier -> "inline" | "virtual" | "explicit" (only for - function_object) - - "constexpr" (only for member_object and function_object) - """ - visibility = None + def _parse_decl_specs_simple(self, outer, typed): + """Just parse the simple ones.""" storage = None inline = None virtual = None @@ -1358,12 +1378,6 @@ class DefinitionParser(object): constexpr = None volatile = None const = None - - if outer: - self.skip_ws() - if self.match(_visibility_re): - visibility = self.matched_text - while 1: # accept any permutation of a subset of some decl-specs self.skip_ws() if not storage: @@ -1409,14 +1423,37 @@ class DefinitionParser(object): if const: continue break + return ASTDeclSpecsSimple(storage, inline, virtual, explicit, constexpr, + volatile, const) + + def _parse_decl_specs(self, outer, typed=True): + """ + visibility storage-class-specifier function-specifier "constexpr" + "volatile" "const" trailing-type-specifier + + storage-class-specifier -> "static" (only for member_object and + function_object) + + function-specifier -> "inline" | "virtual" | "explicit" (only for + function_object) + + "constexpr" (only for member_object and function_object) + """ + visibility = None + leftSepcs = None + rightSpecs = None + if outer: + self.skip_ws() + if self.match(_visibility_re): + visibility = self.matched_text + leftSpecs = self._parse_decl_specs_simple(outer, typed) if typed: trailing = self._parse_trailing_type_spec() + rightSpecs = self._parse_decl_specs_simple(outer, typed) else: trailing = None - return ASTDeclSpecs( - outer, visibility, storage, inline, virtual, explicit, constexpr, - volatile, const, trailing) + return ASTDeclSpecs(outer, visibility, leftSpecs, rightSpecs, trailing) def _parse_declerator(self, named, paramMode=None, typed=True): if paramMode: diff --git a/tests/test_domain_cpp.py b/tests/test_domain_cpp.py index 5b839fadd..2770db657 100644 --- a/tests/test_domain_cpp.py +++ b/tests/test_domain_cpp.py @@ -62,6 +62,8 @@ def test_type_definitions(): check("type", "public MyContainer::const_iterator", "MyContainer::const_iterator") + # test decl specs on right + check("type", "bool const b") check('member', ' const std::string & name = 42', From 83324da8ce6a05cbb6a17b118f166b5790d65892 Mon Sep 17 00:00:00 2001 From: Pete Savage Date: Wed, 4 Feb 2015 12:52:47 +0000 Subject: [PATCH 40/40] Added Usage section to be compatible with Cartouche --- sphinx/ext/napoleon/docstring.py | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/sphinx/ext/napoleon/docstring.py b/sphinx/ext/napoleon/docstring.py index eedc3687d..c54113fd2 100644 --- a/sphinx/ext/napoleon/docstring.py +++ b/sphinx/ext/napoleon/docstring.py @@ -261,6 +261,10 @@ class GoogleDocstring(UnicodeMixin): else: return [] + def _consume_usage_section(self): + lines = self._dedent(self._consume_to_next_section()) + return lines + def _consume_section_header(self): section = next(self._line_iter) stripped_section = section.strip(':') @@ -450,6 +454,13 @@ class GoogleDocstring(UnicodeMixin): use_admonition = self._config.napoleon_use_admonition_for_examples return self._parse_generic_section(section, use_admonition) + def _parse_usage_section(self, section): + header = ['.. rubric:: Usage:', ''] + block = ['.. code-block:: python', ''] + lines = self._consume_usage_section() + lines = self._indent(lines, 3) + return header + block + lines + [''] + def _parse_generic_section(self, section, use_admonition): lines = self._strip_empty(self._consume_to_next_section()) lines = self._dedent(lines)