[Python-modules-commits] [sphinx] 01/03: New upstream version 1.6.6
Dmitry Shachnev
mitya57 at moszumanska.debian.org
Tue Jan 9 16:02:35 UTC 2018
This is an automated email from the git hooks/post-receive script.
mitya57 pushed a commit to branch debian/master
in repository sphinx.
commit 452186e251c05578ef01a1d3c8662fc48fbeea39
Author: Dmitry Shachnev <mitya57 at gmail.com>
Date: Tue Jan 9 18:52:56 2018 +0300
New upstream version 1.6.6
---
CHANGES | 51 +++++++++++
EXAMPLES | 1 +
LICENSE | 2 +-
PKG-INFO | 2 +-
Sphinx.egg-info/PKG-INFO | 2 +-
Sphinx.egg-info/SOURCES.txt | 33 ++++---
doc/_themes/sphinx13/layout.html | 2 +-
doc/_themes/sphinx13/static/sphinx13.css | 2 +-
doc/conf.py | 2 +-
doc/config.rst | 102 +++++++++++++++++----
doc/ext/math.rst | 2 +-
doc/ext/napoleon.rst | 9 +-
doc/latex.rst | 20 +++-
doc/markup/code.rst | 6 +-
doc/markup/inline.rst | 18 ++--
setup.cfg | 2 +-
sphinx-apidoc.py | 2 +-
sphinx-autogen.py | 2 +-
sphinx-build.py | 2 +-
sphinx-quickstart.py | 2 +-
sphinx/__init__.py | 8 +-
sphinx/__main__.py | 2 +-
sphinx/addnodes.py | 2 +-
sphinx/apidoc.py | 16 ++--
sphinx/application.py | 6 +-
sphinx/builders/__init__.py | 8 +-
sphinx/builders/_epub_base.py | 2 +-
sphinx/builders/applehelp.py | 2 +-
sphinx/builders/changes.py | 2 +-
sphinx/builders/devhelp.py | 2 +-
sphinx/builders/gettext.py | 2 +-
sphinx/builders/html.py | 4 +-
sphinx/builders/htmlhelp.py | 4 +-
sphinx/builders/latex.py | 2 +-
sphinx/builders/linkcheck.py | 2 +-
sphinx/builders/manpage.py | 2 +-
sphinx/builders/qthelp.py | 6 +-
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 | 13 ++-
sphinx/deprecation.py | 2 +-
sphinx/directives/__init__.py | 2 +-
sphinx/directives/code.py | 2 +-
sphinx/directives/other.py | 2 +-
sphinx/directives/patches.py | 2 +-
sphinx/domains/__init__.py | 2 +-
sphinx/domains/c.py | 2 +-
sphinx/domains/cpp.py | 21 +++--
sphinx/domains/javascript.py | 2 +-
sphinx/domains/python.py | 2 +-
sphinx/domains/rst.py | 2 +-
sphinx/domains/std.py | 18 ++--
sphinx/environment/__init__.py | 62 ++++++++++---
sphinx/environment/adapters/__init__.py | 2 +-
sphinx/environment/adapters/asset.py | 2 +-
sphinx/environment/adapters/indexentries.py | 2 +-
sphinx/environment/adapters/toctree.py | 2 +-
sphinx/environment/collectors/__init__.py | 2 +-
sphinx/environment/collectors/asset.py | 2 +-
sphinx/environment/collectors/dependencies.py | 2 +-
sphinx/environment/collectors/indexentries.py | 2 +-
sphinx/environment/collectors/metadata.py | 2 +-
sphinx/environment/collectors/title.py | 2 +-
sphinx/environment/collectors/toctree.py | 4 +-
sphinx/errors.py | 2 +-
sphinx/events.py | 2 +-
sphinx/ext/__init__.py | 2 +-
sphinx/ext/autodoc.py | 16 +++-
sphinx/ext/autosectionlabel.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/githubpages.py | 2 +-
sphinx/ext/graphviz.py | 2 +-
sphinx/ext/ifconfig.py | 2 +-
sphinx/ext/imgconverter.py | 2 +-
sphinx/ext/imgmath.py | 2 +-
sphinx/ext/inheritance_diagram.py | 2 +-
sphinx/ext/intersphinx.py | 3 +-
sphinx/ext/jsmath.py | 2 +-
sphinx/ext/linkcode.py | 2 +-
sphinx/ext/mathbase.py | 2 +-
sphinx/ext/mathjax.py | 2 +-
sphinx/ext/napoleon/__init__.py | 8 +-
sphinx/ext/napoleon/docstring.py | 24 ++---
sphinx/ext/napoleon/iterators.py | 2 +-
sphinx/ext/pngmath.py | 2 +-
sphinx/ext/todo.py | 5 +-
sphinx/ext/viewcode.py | 8 +-
sphinx/extension.py | 2 +-
sphinx/highlighting.py | 2 +-
sphinx/io.py | 14 ++-
sphinx/jinja2glue.py | 2 +-
sphinx/locale/__init__.py | 2 +-
sphinx/make_mode.py | 2 +-
sphinx/parsers.py | 9 +-
sphinx/pycode/__init__.py | 2 +-
sphinx/pycode/nodes.py | 4 +-
sphinx/pygments_styles.py | 2 +-
sphinx/quickstart.py | 27 +++---
sphinx/roles.py | 2 +-
sphinx/search/__init__.py | 2 +-
sphinx/search/en.py | 2 +-
sphinx/search/ja.py | 2 +-
sphinx/search/jssplitter.py | 2 +-
sphinx/search/zh.py | 2 +-
sphinx/setup_command.py | 12 +--
sphinx/testing/__init__.py | 2 +-
sphinx/testing/fixtures.py | 2 +-
sphinx/testing/path.py | 2 +-
sphinx/testing/util.py | 4 +-
sphinx/texinputs/sphinx.sty | 76 +++++++++++----
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_t | 4 +-
sphinx/themes/basic/static/searchtools.js_t | 2 +-
sphinx/themes/basic/static/websupport.js | 2 +-
sphinx/themes/classic/layout.html | 2 +-
sphinx/themes/classic/static/classic.css_t | 2 +-
sphinx/themes/classic/static/sidebar.js_t | 2 +-
sphinx/themes/epub/epub-cover.html | 2 +-
sphinx/themes/epub/layout.html | 2 +-
sphinx/themes/epub/static/epub.css_t | 2 +-
sphinx/themes/haiku/layout.html | 2 +-
sphinx/themes/haiku/static/haiku.css_t | 2 +-
sphinx/themes/nature/static/nature.css_t | 2 +-
sphinx/themes/nonav/layout.html | 2 +-
sphinx/themes/nonav/static/nonav.css | 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 | 4 +-
sphinx/transforms/__init__.py | 6 +-
sphinx/transforms/compact_bullet_list.py | 8 +-
sphinx/transforms/i18n.py | 2 +-
sphinx/transforms/post_transforms/__init__.py | 2 +-
sphinx/transforms/post_transforms/images.py | 2 +-
sphinx/util/__init__.py | 10 +-
sphinx/util/compat.py | 2 +-
sphinx/util/console.py | 2 +-
sphinx/util/docfields.py | 2 +-
sphinx/util/docstrings.py | 2 +-
sphinx/util/docutils.py | 2 +-
sphinx/util/fileutil.py | 2 +-
sphinx/util/i18n.py | 2 +-
sphinx/util/images.py | 4 +-
sphinx/util/inspect.py | 10 +-
sphinx/util/inventory.py | 2 +-
sphinx/util/jsdump.py | 2 +-
sphinx/util/jsonimpl.py | 2 +-
sphinx/util/logging.py | 59 ++++++++----
sphinx/util/matching.py | 2 +-
sphinx/util/nodes.py | 2 +-
sphinx/util/osutil.py | 2 +-
sphinx/util/parallel.py | 2 +-
sphinx/util/png.py | 2 +-
sphinx/util/pycompat.py | 2 +-
sphinx/util/requests.py | 2 +-
sphinx/util/rst.py | 2 +-
sphinx/util/smartypants.py | 2 +-
sphinx/util/stemmer/__init__.py | 2 +-
sphinx/util/tags.py | 2 +-
sphinx/util/template.py | 2 +-
sphinx/util/texescape.py | 2 +-
sphinx/util/typing.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/html5.py | 2 +-
sphinx/writers/latex.py | 57 ++++++++----
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/conftest.py | 2 +-
tests/py35/test_autodoc_py35.py | 2 +-
tests/roots/test-apidoc-toc/mypackage/__init__.py | 0
tests/roots/test-apidoc-toc/mypackage/main.py | 16 ++++
.../roots/test-apidoc-toc/mypackage/no_init/foo.py | 1 +
.../test-apidoc-toc/mypackage/resource/__init__.py | 0
.../mypackage/resource/resource.txt | 1 +
.../mypackage/something/__init__.py | 1 +
.../bom.po | 0
.../test-builder-gettext-dont-rebuild-mo/bom.rst | 5 +
.../test-builder-gettext-dont-rebuild-mo/conf.py | 7 ++
.../test-builder-gettext-dont-rebuild-mo/index.rst | 6 ++
tests/roots/test-directive-code/emphasize.rst | 7 ++
.../{test-doctest => test-ext-doctest}/conf.py | 0
.../{test-doctest => test-ext-doctest}/doctest.txt | 0
tests/roots/test-ext-todo/index.rst | 2 +
tests/roots/test-ext-viewcode/index.rst | 5 +
tests/roots/test-ext-viewcode/spam/mod1.py | 7 ++
tests/roots/test-ext-viewcode/spam/mod3.py | 2 +
.../expects/longtable_having_verbatim.tex | 1 +
.../expects/table_having_verbatim.tex | 1 +
tests/roots/test-root/_static/README | 1 -
tests/roots/test-root/_static/excluded.css | 1 -
tests/roots/test-root/_static/subdir/foo.css | 1 -
tests/roots/test-root/conf.py | 5 -
tests/roots/test-root/robots.txt | 2 -
tests/roots/test-root/subdir.po | 9 --
tests/roots/test-root/templated.css_t | 2 -
.../test_theme/staticfiles}/layout.html | 0
.../test_theme/staticfiles}/static/staticimg.png | Bin
.../staticfiles}/static/statictmpl.html_t | 0
.../test_theme/staticfiles}/theme.conf | 0
.../roots/{test-root => test-theming}/ziptheme.zip | Bin
tests/run.py | 2 +-
tests/test_api_translator.py | 2 +-
tests/test_apidoc.py | 79 +++++++++++++++-
tests/test_application.py | 2 +-
tests/test_autodoc.py | 2 +-
tests/test_build.py | 10 +-
tests/test_build_applehelp.py | 2 +-
tests/test_build_gettext.py | 2 +-
tests/test_build_html.py | 59 ++++--------
tests/test_build_html5.py | 6 +-
tests/test_build_latex.py | 54 ++++++++---
tests/test_build_linkcheck.py | 2 +-
tests/test_build_manpage.py | 2 +-
tests/test_build_texinfo.py | 2 +-
tests/test_build_text.py | 2 +-
tests/test_catalogs.py | 2 +-
tests/test_config.py | 2 +-
tests/test_correct_year.py | 2 +-
tests/test_directive_code.py | 10 +-
tests/test_directive_only.py | 2 +-
tests/test_docutilsconf.py | 2 +-
tests/test_domain_cpp.py | 2 +-
tests/test_domain_js.py | 2 +-
tests/test_domain_py.py | 2 +-
tests/test_domain_rst.py | 2 +-
tests/test_domain_std.py | 2 +-
tests/test_environment.py | 2 +-
tests/test_environment_indexentries.py | 2 +-
tests/test_environment_toctree.py | 2 +-
tests/test_ext_autodoc.py | 2 +-
tests/test_ext_autosectionlabel.py | 2 +-
tests/test_ext_autosummary.py | 2 +-
tests/test_ext_coverage.py | 2 +-
tests/test_ext_doctest.py | 4 +-
tests/test_ext_githubpages.py | 2 +-
tests/test_ext_graphviz.py | 2 +-
tests/test_ext_ifconfig.py | 2 +-
tests/test_ext_imgconverter.py | 2 +-
tests/test_ext_inheritance_diagram.py | 2 +-
tests/test_ext_intersphinx.py | 10 +-
tests/test_ext_math.py | 2 +-
tests/test_ext_napoleon.py | 2 +-
tests/test_ext_napoleon_docstring.py | 2 +-
tests/test_ext_napoleon_iterators.py | 2 +-
tests/test_ext_todo.py | 10 +-
tests/test_ext_viewcode.py | 8 +-
tests/test_highlighting.py | 2 +-
tests/test_intl.py | 28 +++---
tests/test_markup.py | 5 +-
tests/test_metadata.py | 2 +-
tests/test_quickstart.py | 2 +-
tests/test_search.py | 2 +-
tests/test_setup_command.py | 2 +-
tests/test_templating.py | 2 +-
tests/test_theming.py | 25 ++++-
tests/test_toctree.py | 2 +-
tests/test_util.py | 2 +-
tests/test_util_fileutil.py | 2 +-
tests/test_util_i18n.py | 2 +-
tests/test_util_images.py | 2 +-
tests/test_util_inspect.py | 22 ++++-
tests/test_util_logging.py | 2 +-
tests/test_util_matching.py | 2 +-
tests/test_util_nodes.py | 2 +-
tests/test_util_rst.py | 2 +-
tests/test_versioning.py | 2 +-
tests/test_websupport.py | 2 +-
tests/test_writer_latex.py | 2 +-
utils/bump_version.py | 2 +-
utils/check_sources.py | 2 +-
utils/jssplitter_generator.py | 2 +-
314 files changed, 1065 insertions(+), 584 deletions(-)
diff --git a/CHANGES b/CHANGES
index 70652ce..05c1abd 100644
--- a/CHANGES
+++ b/CHANGES
@@ -1,3 +1,54 @@
+Release 1.6.6 (released Jan 08, 2018)
+=====================================
+
+Dependencies
+------------
+
+Incompatible changes
+--------------------
+
+Deprecated
+----------
+
+Features added
+--------------
+
+* #4181: autodoc: Sort dictionary keys when possible
+* ``VerbatimHighlightColor`` is a new
+ :ref:`LaTeX 'sphinxsetup' <latexsphinxsetup>` key (refs: #4285)
+* Easier customizability of LaTeX macros involved in rendering of code-blocks
+* Show traceback if conf.py raises an exception (refs: #4369)
+* Add :confval:`smartquotes` to disable smart quotes through ``conf.py``
+ (refs: #3967)
+* Add :confval:`smartquotes_action` and :confval:`smartquotes_excludes`
+ (refs: #4142, #4357)
+
+Bugs fixed
+----------
+
+* #4334: sphinx-apidoc: Don't generate references to non-existing files in TOC
+* #4206: latex: reST label between paragraphs loses paragraph break
+* #4231: html: Apply fixFirefoxAnchorBug only under Firefox
+* #4221: napoleon depends on autodoc, but users need to load it manually
+* #2298: automodule fails to document a class attribute
+* #4099: C++: properly link class reference to class from inside constructor
+* #4267: PDF build broken by Unicode U+2116 NUMERO SIGN character
+* #4249: PDF output: Pygments error highlighting increases line spacing in
+ code blocks
+* #1238: Support ``:emphasize-lines:`` in PDF output
+* #4279: Sphinx crashes with pickling error when run with multiple processes and
+ remote image
+* #1421: Respect the quiet flag in sphinx-quickstart
+* #4281: Race conditions when creating output directory
+* #4315: For PDF 'howto' documents, ``latex_toplevel_sectioning='part'`` generates
+ ``\chapter`` commands
+* #4214: Two todolist directives break sphinx-1.6.5
+* Fix links to external option docs with intersphinx (refs: #3769)
+* #4091: Private members not documented without :undoc-members:
+
+Testing
+--------
+
Release 1.6.5 (released Oct 23, 2017)
=====================================
diff --git a/EXAMPLES b/EXAMPLES
index fa91b20..9d3b243 100644
--- a/EXAMPLES
+++ b/EXAMPLES
@@ -111,6 +111,7 @@ Documentation using the sphinxdoc theme
Documentation using another builtin theme
-----------------------------------------
+* Arcade: http://arcade.academy/ (sphinx_rtd_theme)
* ASE: https://wiki.fysik.dtu.dk/ase/ (sphinx_rtd_theme)
* C/C++ Development with Eclipse: http://eclipsebook.in/ (agogo)
* ESWP3 (http://eswp3.org) (sphinx_rtd_theme)
diff --git a/LICENSE b/LICENSE
index a2783ab..19f1090 100644
--- a/LICENSE
+++ b/LICENSE
@@ -1,7 +1,7 @@
License for Sphinx
==================
-Copyright (c) 2007-2017 by the Sphinx team (see AUTHORS file).
+Copyright (c) 2007-2018 by the Sphinx team (see AUTHORS file).
All rights reserved.
Redistribution and use in source and binary forms, with or without
diff --git a/PKG-INFO b/PKG-INFO
index dc7d8aa..0a07f98 100644
--- a/PKG-INFO
+++ b/PKG-INFO
@@ -1,6 +1,6 @@
Metadata-Version: 1.1
Name: Sphinx
-Version: 1.6.5
+Version: 1.6.6
Summary: Python documentation generator
Home-page: http://sphinx-doc.org/
Author: Georg Brandl
diff --git a/Sphinx.egg-info/PKG-INFO b/Sphinx.egg-info/PKG-INFO
index dc7d8aa..0a07f98 100644
--- a/Sphinx.egg-info/PKG-INFO
+++ b/Sphinx.egg-info/PKG-INFO
@@ -1,6 +1,6 @@
Metadata-Version: 1.1
Name: Sphinx
-Version: 1.6.5
+Version: 1.6.6
Summary: Python documentation generator
Home-page: http://sphinx-doc.org/
Author: Georg Brandl
diff --git a/Sphinx.egg-info/SOURCES.txt b/Sphinx.egg-info/SOURCES.txt
index 62786bb..d2eff6b 100644
--- a/Sphinx.egg-info/SOURCES.txt
+++ b/Sphinx.egg-info/SOURCES.txt
@@ -700,6 +700,12 @@ tests/roots/test-api-set-translator/nonext/conf.py
tests/roots/test-apidoc-pep420/a/b/c/__init__.py
tests/roots/test-apidoc-pep420/a/b/c/d.py
tests/roots/test-apidoc-pep420/a/b/x/y.py
+tests/roots/test-apidoc-toc/mypackage/__init__.py
+tests/roots/test-apidoc-toc/mypackage/main.py
+tests/roots/test-apidoc-toc/mypackage/no_init/foo.py
+tests/roots/test-apidoc-toc/mypackage/resource/__init__.py
+tests/roots/test-apidoc-toc/mypackage/resource/resource.txt
+tests/roots/test-apidoc-toc/mypackage/something/__init__.py
tests/roots/test-apidoc-trailing-underscore/package_/__init__.py
tests/roots/test-apidoc-trailing-underscore/package_/module_.py
tests/roots/test-autosummary/conf.py
@@ -720,6 +726,10 @@ tests/roots/test-build-text/nonascii_maxwidth.txt
tests/roots/test-build-text/nonascii_table.txt
tests/roots/test-build-text/nonascii_title.txt
tests/roots/test-build-text/table.txt
+tests/roots/test-builder-gettext-dont-rebuild-mo/bom.po
+tests/roots/test-builder-gettext-dont-rebuild-mo/bom.rst
+tests/roots/test-builder-gettext-dont-rebuild-mo/conf.py
+tests/roots/test-builder-gettext-dont-rebuild-mo/index.rst
tests/roots/test-circular/conf.py
tests/roots/test-circular/contents.rst
tests/roots/test-circular/sub.rst
@@ -732,6 +742,7 @@ tests/roots/test-default_role/index.rst
tests/roots/test-directive-code/caption.rst
tests/roots/test-directive-code/classes.rst
tests/roots/test-directive-code/conf.py
+tests/roots/test-directive-code/emphasize.rst
tests/roots/test-directive-code/empty.inc
tests/roots/test-directive-code/index.rst
tests/roots/test-directive-code/linenos.rst
@@ -747,8 +758,6 @@ tests/roots/test-directive-only/contents.rst
tests/roots/test-directive-only/only.rst
tests/roots/test-directives-raw/conf.py
tests/roots/test-directives-raw/index.rst
-tests/roots/test-doctest/conf.py
-tests/roots/test-doctest/doctest.txt
tests/roots/test-docutilsconf/conf.py
tests/roots/test-docutilsconf/contents.txt
tests/roots/test-docutilsconf/docutils.conf
@@ -780,6 +789,8 @@ tests/roots/test-ext-autosectionlabel-prefix-document/index.rst
tests/roots/test-ext-autosummary/autosummary_dummy_module.py
tests/roots/test-ext-autosummary/conf.py
tests/roots/test-ext-autosummary/contents.rst
+tests/roots/test-ext-doctest/conf.py
+tests/roots/test-ext-doctest/doctest.txt
tests/roots/test-ext-githubpages/conf.py
tests/roots/test-ext-githubpages/index.rst
tests/roots/test-ext-graphviz/conf.py
@@ -813,6 +824,7 @@ tests/roots/test-ext-viewcode/objects.rst
tests/roots/test-ext-viewcode/spam/__init__.py
tests/roots/test-ext-viewcode/spam/mod1.py
tests/roots/test-ext-viewcode/spam/mod2.py
+tests/roots/test-ext-viewcode/spam/mod3.py
tests/roots/test-footnotes/bar.rst
tests/roots/test-footnotes/baz.rst
tests/roots/test-footnotes/conf.py
@@ -975,7 +987,6 @@ tests/roots/test-root/Makefile
tests/roots/test-root/autodoc.txt
tests/roots/test-root/autodoc_fodder.py
tests/roots/test-root/autodoc_missing_imports.py
-tests/roots/test-root/bom.po
tests/roots/test-root/bom.txt
tests/roots/test-root/conf.py
tests/roots/test-root/contents.txt
@@ -1000,18 +1011,11 @@ tests/roots/test-root/otherext.foo
tests/roots/test-root/parsermod.py
tests/roots/test-root/quotes.inc
tests/roots/test-root/rimg.png
-tests/roots/test-root/robots.txt
-tests/roots/test-root/subdir.po
tests/roots/test-root/svgimg.pdf
tests/roots/test-root/svgimg.svg
tests/roots/test-root/tabs.inc
-tests/roots/test-root/templated.css_t
tests/roots/test-root/test.inc
tests/roots/test-root/wrongenc.inc
-tests/roots/test-root/ziptheme.zip
-tests/roots/test-root/_static/README
-tests/roots/test-root/_static/excluded.css
-tests/roots/test-root/_static/subdir/foo.css
tests/roots/test-root/_templates/contentssb.html
tests/roots/test-root/_templates/customsb.html
tests/roots/test-root/_templates/layout.html
@@ -1024,10 +1028,6 @@ tests/roots/test-root/subdir/img.png
tests/roots/test-root/subdir/include.inc
tests/roots/test-root/subdir/includes.txt
tests/roots/test-root/subdir/simg.png
-tests/roots/test-root/testtheme/layout.html
-tests/roots/test-root/testtheme/theme.conf
-tests/roots/test-root/testtheme/static/staticimg.png
-tests/roots/test-root/testtheme/static/statictmpl.html_t
tests/roots/test-search/conf.py
tests/roots/test-search/index.rst
tests/roots/test-search/tocitem.rst
@@ -1049,7 +1049,12 @@ tests/roots/test-theming/conf.py
tests/roots/test-theming/index.rst
tests/roots/test-theming/parent.zip
tests/roots/test-theming/setup.py
+tests/roots/test-theming/ziptheme.zip
tests/roots/test-theming/test_theme/__init__.py
+tests/roots/test-theming/test_theme/staticfiles/layout.html
+tests/roots/test-theming/test_theme/staticfiles/theme.conf
+tests/roots/test-theming/test_theme/staticfiles/static/staticimg.png
+tests/roots/test-theming/test_theme/staticfiles/static/statictmpl.html_t
tests/roots/test-theming/test_theme/test-theme/theme.conf
tests/roots/test-tocdepth/bar.rst
tests/roots/test-tocdepth/baz.rst
diff --git a/doc/_themes/sphinx13/layout.html b/doc/_themes/sphinx13/layout.html
index fdac6d0..cd870fe 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-2017 by the Sphinx team, see AUTHORS.
+ :copyright: Copyright 2007-2018 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 d15fbae..6bdc5a9 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-2017 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
diff --git a/doc/conf.py b/doc/conf.py
index 62c5c13..1f19b53 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -15,7 +15,7 @@ templates_path = ['_templates']
exclude_patterns = ['_build']
project = 'Sphinx'
-copyright = '2007-2017, Georg Brandl and the Sphinx team'
+copyright = '2007-2018, Georg Brandl and the Sphinx team'
version = sphinx.__display_version__
release = version
show_authors = True
diff --git a/doc/config.rst b/doc/config.rst
index b615dc4..6b7690c 100644
--- a/doc/config.rst
+++ b/doc/config.rst
@@ -15,15 +15,12 @@ and output behavior.
An optional file `docutils.conf`_ can be added to the configuration
directory to adjust `Docutils`_ configuration if not otherwise overriden or
- set by Sphinx; this applies in particular to the `Docutils smart_quotes
- setting`_ (Note that Sphinx applies smart quotes transform by default.)
+ set by Sphinx.
.. _`docutils`: http://docutils.sourceforge.net/
.. _`docutils.conf`: http://docutils.sourceforge.net/docs/user/config.html
- .. _`Docutils smart_quotes setting`: http://docutils.sourceforge.net/docs/user/config.html#smart-quotes
-
The configuration file is executed as Python code at build time (using
:func:`execfile`, and with the current directory set to its containing
directory), and therefore can execute arbitrarily complex code. Sphinx then
@@ -314,8 +311,8 @@ General configuration
.. confval:: numfig
If true, figures, tables and code-blocks are automatically numbered if they
- have a caption. At same time, the `numref` role is enabled. For now, it
- works only with the HTML builder and LaTeX builder. Default is ``False``.
+ have a caption. The :rst:role:`numref` role is enabled.
+ Obeyed so far only by HTML and LaTeX builders. Default is ``False``.
.. note::
@@ -338,13 +335,81 @@ General configuration
.. confval:: numfig_secnum_depth
- The scope of figure numbers, that is, the numfig feature numbers figures
- in which scope. ``0`` means "whole document". ``1`` means "in a section".
- Sphinx numbers like x.1, x.2, x.3... ``2`` means "in a subsection". Sphinx
- numbers like x.x.1, x.x.2, x.x.3..., and so on. Default is ``1``.
+ - if set to ``0``, figures, tables and code-blocks are continuously numbered
+ starting at ``1``.
+ - if ``1`` (default) numbers will be ``x.1``, ``x.2``, ... with ``x``
+ the section number (top level sectioning; no ``x.`` if no section).
+ This naturally applies only if section numbering has been activated via
+ the ``:numbered:`` option of the :rst:dir:`toctree` directive.
+ - ``2`` means that numbers will be ``x.y.1``, ``x.y.2``, ... if located in
+ a sub-section (but still ``x.1``, ``x.2``, ... if located directly under a
+ section and ``1``, ``2``, ... if not in any top level section.)
+ - etc...
+
+ .. note::
+
+ The LaTeX builder currently ignores this configuration setting. It will
+ obey it at Sphinx 1.7.
.. versionadded:: 1.3
+.. confval:: smartquotes
+
+ If true, the `Docutils Smart Quotes transform`__, originally based on
+ `SmartyPants`__ (limited to English) and currently applying to many
+ languages, will be used to convert quotes and dashes to typographically
+ correct entities. Default: ``True``.
+
+ __ http://docutils.sourceforge.net/docs/user/smartquotes.html
+ __ https://daringfireball.net/projects/smartypants/
+
+ .. versionadded:: 1.6.6
+ It replaces deprecated :confval:`html_use_smartypants`.
+ It applies by default to all builders except ``man`` and ``text``
+ (see :confval:`smartquotes_excludes`.)
+
+ A `docutils.conf`__ file located in the configuration directory (or a
+ global :file:`~/.docutils` file) is obeyed unconditionally if it
+ *deactivates* smart quotes via the corresponding `Docutils option`__. But
+ if it *activates* them, then :confval:`smartquotes` does prevail.
+
+ __ http://docutils.sourceforge.net/docs/user/config.html
+ __ http://docutils.sourceforge.net/docs/user/config.html#smart-quotes
+
+.. confval:: smartquotes_action
+
+ This string, for use with Docutils ``0.14`` or later, customizes the Smart
+ Quotes transform. See the file :file:`smartquotes.py` at the `Docutils
+ repository`__ for details. The default ``'qDe'`` educates normal **q**\
+ uote characters ``"``, ``'``, em- and en-**D**\ ashes ``---``, ``--``, and
+ **e**\ llipses ``...``.
+
+ .. versionadded:: 1.6.6
+
+ __ https://sourceforge.net/p/docutils/code/HEAD/tree/trunk/docutils/
+
+.. confval:: smartquotes_excludes
+
+ This is a ``dict`` whose default is::
+
+ {'languages': ['ja'], 'builders': ['man', 'text']}
+
+ Each entry gives a sufficient condition to ignore the
+ :confval:`smartquotes` setting and deactivate the Smart Quotes transform.
+ Accepted keys are as above ``'builders'`` or ``'languages'``.
+ The values are lists.
+
+ .. note:: Currently, in case of invocation of :program:`make` with multiple
+ targets, the first target name is the only one which is tested against
+ the ``'builders'`` entry and it decides for all. Also, a ``make text``
+ following ``make html`` needs to be issued in the form ``make text
+ O="-E"`` to force re-parsing of source files, as the cached ones are
+ already transformed. On the other hand the issue does not arise with
+ direct usage of :program:`sphinx-build` as it caches
+ (in its default usage) the parsed source files in per builder locations.
+
+ .. versionadded:: 1.6.6
+
.. confval:: tls_verify
If true, Sphinx verifies server certifications. Default is ``True``.
@@ -776,15 +841,11 @@ that use Sphinx's HTMLWriter class.
.. confval:: html_use_smartypants
- If true, `SmartyPants <https://daringfireball.net/projects/smartypants/>`_
- will be used to convert quotes and dashes to typographically correct
+ If true, quotes and dashes are converted to typographically correct
entities. Default: ``True``.
.. deprecated:: 1.6
- To disable or customize smart quotes, use the Docutils configuration file
- (``docutils.conf``) instead to set there its `smart_quotes option`_.
-
- .. _`smart_quotes option`: http://docutils.sourceforge.net/docs/user/config.html#smart-quotes
+ To disable smart quotes, use rather :confval:`smartquotes`.
.. confval:: html_add_permalinks
@@ -1609,10 +1670,15 @@ These options influence LaTeX output. See further :doc:`latex`.
.. confval:: latex_toplevel_sectioning
This value determines the topmost sectioning unit. It should be chosen from
- ``part``, ``chapter`` or ``section``. The default is ``None``; the topmost
- sectioning unit is switched by documentclass. ``section`` is used if
+ ``'part'``, ``'chapter'`` or ``'section'``. The default is ``None``;
+ the topmost
+ sectioning unit is switched by documentclass: ``section`` is used if
documentclass will be ``howto``, otherwise ``chapter`` will be used.
+ Note that if LaTeX uses ``\part`` command, then the numbering of sectioning
+ units one level deep gets off-sync with HTML numbering, because LaTeX
+ numbers continuously ``\chapter`` (or ``\section`` for ``howto``.)
+
.. versionadded:: 1.4
.. confval:: latex_appendices
diff --git a/doc/ext/math.rst b/doc/ext/math.rst
index 3d25d09..ca53f3a 100644
--- a/doc/ext/math.rst
+++ b/doc/ext/math.rst
@@ -78,7 +78,7 @@ or use Python raw strings (``r"raw"``).
Normally, equations are not numbered. If you want your equation to get a
number, use the ``label`` option. When given, it selects an internal label
for the equation, by which it can be cross-referenced, and causes an equation
- number to be issued. See :rst:role:`eqref` for an example. The numbering
+ number to be issued. See :rst:role:`eq` for an example. The numbering
style depends on the output format.
There is also an option ``nowrap`` that prevents any wrapping of the given
diff --git a/doc/ext/napoleon.rst b/doc/ext/napoleon.rst
index ea3e404..f7e9081 100644
--- a/doc/ext/napoleon.rst
+++ b/doc/ext/napoleon.rst
@@ -68,8 +68,8 @@ Getting Started
# conf.py
- # Add autodoc and napoleon to the extensions list
- extensions = ['sphinx.ext.autodoc', 'sphinx.ext.napoleon']
+ # Add napoleon to the extensions list
+ extensions = ['sphinx.ext.napoleon']
2. Use `sphinx-apidoc` to build your API documentation::
@@ -246,13 +246,12 @@ Configuration
Listed below are all the settings used by napoleon and their default
values. These settings can be changed in the Sphinx `conf.py` file. Make
-sure that both "sphinx.ext.autodoc" and "sphinx.ext.napoleon" are
-enabled in `conf.py`::
+sure that "sphinx.ext.napoleon" is enabled in `conf.py`::
# conf.py
# Add any Sphinx extension module names here, as strings
- extensions = ['sphinx.ext.autodoc', 'sphinx.ext.napoleon']
+ extensions = ['sphinx.ext.napoleon']
# Napoleon settings
napoleon_google_docstring = True
diff --git a/doc/latex.rst b/doc/latex.rst
index 0cd91fa..2197efc 100644
--- a/doc/latex.rst
+++ b/doc/latex.rst
@@ -256,6 +256,16 @@ The available styling options
``VerbatimBorderColor``
default ``{rgb}{0,0,0}``. The frame color, defaults to black.
+``VerbatimHighlightColor``
+ default ``{rgb}{0.878,1,1}``. The color for highlighted lines.
+
+ .. versionadded:: 1.6.6
+
+.. note::
+
+ Starting with this colour key, and for all others coming next, the actual
+ names declared to "color" or "xcolor" are prefixed with "sphinx".
+
``verbatimsep``
default ``\fboxsep``. The separation between code lines and the frame.
@@ -277,11 +287,6 @@ The available styling options
default ``{rgb}{0,0,0}`` (black). The colour for the two horizontal rules
used by Sphinx in LaTeX for styling a :dudir:`note` type admonition.
-.. note::
-
- The actual colour names declared to "color" or "xcolor" are prefixed with
- "sphinx".
-
``noteborder``, ``hintborder``, ``importantborder``, ``tipborder``
default ``0.5pt``. The width of the two horizontal rules.
@@ -443,6 +448,11 @@ Environments
.. versionadded:: 1.5
options ``verbatimwithframe``, ``verbatimwrapslines``,
``verbatimsep``, ``verbatimborder``.
+ .. versionadded:: 1.6.6
+ support for ``:emphasize-lines:`` option
+ .. versionadded:: 1.6.6
+ easier customizability of the formatting via exposed to user LaTeX macros
+ such as ``\sphinxVerbatimHighlightLine``.
- the bibliography uses ``sphinxthebibliography`` and the Python Module index
as well as the general index both use ``sphinxtheindex``; these environments
are wrappers of the ``thebibliography`` and respectively ``theindex``
diff --git a/doc/markup/code.rst b/doc/markup/code.rst
index cb3e55b..0021af5 100644
--- a/doc/markup/code.rst
+++ b/doc/markup/code.rst
@@ -121,6 +121,8 @@ emphasize particular lines::
.. versionchanged:: 1.3
``lineno-start`` has been added.
+.. versionchanged:: 1.6.6
+ LaTeX supports the ``emphasize-lines`` option.
Includes
^^^^^^^^
@@ -188,8 +190,8 @@ Includes
``lines``, the first allowed line having by convention the line number ``1``.
When lines have been selected in any of the ways described above, the
- line numbers in ``emphasize-lines`` also refer to the selection, with the
- first selected line having number ``1``.
+ line numbers in ``emphasize-lines`` refer to those selected lines, counted
+ consecutively starting at ``1``.
When specifying particular parts of a file to display, it can be useful to
display the original line numbers. This can be done using the
diff --git a/doc/markup/inline.rst b/doc/markup/inline.rst
index a59585b..7ed3e72 100644
--- a/doc/markup/inline.rst
+++ b/doc/markup/inline.rst
@@ -222,15 +222,15 @@ Cross-referencing figures by figure number
reST labels are used. When you use this role, it will insert a reference to
the figure with link text by its figure number like "Fig. 1.1".
- If an explicit link text is given (like usual: ``:numref:`Image of Sphinx (Fig.
- %s) <my-figure>```), the link caption will be the title of the reference.
- As a special character, `%s` and `{number}` will be replaced to figure
- number. `{name}` will be replaced to figure caption.
- If no explicit link text is given, the value of :confval:`numfig_format` is
- used to default value of link text.
-
- If :confval:`numfig` is ``False``, figures are not numbered.
- so this role inserts not a reference but labels or link text.
+ If an explicit link text is given (as usual: ``:numref:`Image of Sphinx (Fig.
+ %s) <my-figure>```), the link caption will serve as title of the reference.
+ As placeholders, `%s` and `{number}` get replaced by the figure
+ number and `{name}` by the figure caption.
+ If no explicit link text is given, the :confval:`numfig_format` setting is
+ used as fall-back default.
+
+ If :confval:`numfig` is ``False``, figures are not numbered,
+ so this role inserts not a reference but the label or the link text.
Cross-referencing other items of interest
-----------------------------------------
diff --git a/setup.cfg b/setup.cfg
index 24d65d2..4a125d4 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -25,7 +25,7 @@ universal = 1
[flake8]
max-line-length = 95
-ignore = E116,E241,E251
+ignore = E116,E241,E251,E741
exclude = .git,.tox,tests/*,build/*,sphinx/search/*,sphinx/pycode/pgen2/*,doc/ext/example*.py
[build_sphinx]
diff --git a/sphinx-apidoc.py b/sphinx-apidoc.py
index 0290d6c..8279fea 100755
--- a/sphinx-apidoc.py
+++ b/sphinx-apidoc.py
@@ -4,7 +4,7 @@
Sphinx - Python documentation toolchain
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- :copyright: Copyright 2007-2017 by the Sphinx team, see AUTHORS.
+ :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
diff --git a/sphinx-autogen.py b/sphinx-autogen.py
index 8320b2c..6c10f0e 100755
--- a/sphinx-autogen.py
+++ b/sphinx-autogen.py
@@ -4,7 +4,7 @@
Sphinx - Python documentation toolchain
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- :copyright: Copyright 2007-2017 by the Sphinx team, see AUTHORS.
+ :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
diff --git a/sphinx-build.py b/sphinx-build.py
index ae60c07..1b8d140 100755
--- a/sphinx-build.py
+++ b/sphinx-build.py
@@ -4,7 +4,7 @@
Sphinx - Python documentation toolchain
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- :copyright: Copyright 2007-2017 by the Sphinx team, see AUTHORS.
+ :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
diff --git a/sphinx-quickstart.py b/sphinx-quickstart.py
index bf8423f..81d6b66 100755
--- a/sphinx-quickstart.py
+++ b/sphinx-quickstart.py
@@ -4,7 +4,7 @@
Sphinx - Python documentation toolchain
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- :copyright: Copyright 2007-2017 by the Sphinx team, see AUTHORS.
+ :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
diff --git a/sphinx/__init__.py b/sphinx/__init__.py
index 91e1f90..332bfe9 100644
--- a/sphinx/__init__.py
+++ b/sphinx/__init__.py
@@ -5,7 +5,7 @@
The Sphinx documentation toolchain.
- :copyright: Copyright 2007-2017 by the Sphinx team, see AUTHORS.
+ :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
@@ -34,13 +34,13 @@ if 'PYTHONWARNINGS' not in os.environ:
warnings.filterwarnings('ignore', "'U' mode is deprecated",
DeprecationWarning, module='docutils.io')
-__version__ = '1.6.5'
-__released__ = '1.6.5' # used when Sphinx builds its own docs
+__version__ = '1.6.6'
+__released__ = '1.6.6' # used when Sphinx builds its own docs
# version info for better programmatic use
# possible values for 3rd element: 'alpha', 'beta', 'rc', 'final'
# 'final' has 0 as the last element
-version_info = (1, 6, 5, 'final', 0)
+version_info = (1, 6, 6, 'final', 0)
package_dir = path.abspath(path.dirname(__file__))
diff --git a/sphinx/__main__.py b/sphinx/__main__.py
index 544505a..06b1812 100644
--- a/sphinx/__main__.py
+++ b/sphinx/__main__.py
@@ -5,7 +5,7 @@
The Sphinx documentation toolchain.
- :copyright: Copyright 2007-2017 by the Sphinx team, see AUTHORS.
+ :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
import sys
diff --git a/sphinx/addnodes.py b/sphinx/addnodes.py
index 762dc9b..e6999bd 100644
--- a/sphinx/addnodes.py
+++ b/sphinx/addnodes.py
@@ -5,7 +5,7 @@
Additional docutils nodes.
- :copyright: Copyright 2007-2017 by the Sphinx team, see AUTHORS.
+ :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
diff --git a/sphinx/apidoc.py b/sphinx/apidoc.py
... 5363 lines suppressed ...
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/python-modules/packages/sphinx.git
More information about the Python-modules-commits
mailing list