Update sphinx to 1.6.6

[pyup-bot]

There's a new version of Sphinx available.
You are currently using 1.5.5. I have updated it to 1.6.6

These links might come in handy: PyPI | Changelog | Homepage

Changelog

1.6.6

=====================================

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:

1.6.5

=====================================

Features added

• 4107: Make searchtools.js compatible with pre-Sphinx1.5 templates
• 4112: Don't override the smart_quotes setting if it was already set
• 4125: Display reference texts of original and translated passages on
  i18n warning message
• 4147: Include the exception when logging PO/MO file read/write

Bugs fixed

• 4085: Failed PDF build from image in parsed-literal using :align: option
• 4100: Remove debug print from autodoc extension
• 3987: Changing theme from alabaster causes HTML build to fail
• 4096: C++, don't crash when using the wrong role type. Thanks to mitya57.
• 4070, 4111: crashes when the warning message contains format strings (again)
• 4108: Search word highlighting breaks SVG images
• 3692: Unable to build HTML if writing .buildinfo failed
• 4152: HTML writer crashes if a field list is placed on top of the document
• 4063: Sphinx crashes when labeling directive .. todolist::
• 4134: [doc] :file:docutils.conf is not documented explicitly
• 4169: Chinese language doesn't trigger Chinese search automatically
• 1020: ext.todo todolist not linking to the page in pdflatex
• 3965: New quickstart generates wrong SPHINXBUILD in Makefile
• 3739: :module: option is ignored at content of pyobjects
• 4149: Documentation: Help choosing :confval:latex_engine
• 4090: [doc] :confval:latex_additional_files with extra LaTeX macros should
  not use .tex extension
• Failed to convert reST parser error to warning (refs: 4132)

1.6.4

=====================================

Features added

• 3926: Add autodoc_warningiserror to suppress the behavior of -W
  option during importing target modules on autodoc

Bugs fixed

• 3924: docname lost after dynamically parsing RST in extension
• 3946: Typo in sphinx.sty (this was a bug with no effect in default context)
• :pep: and :rfc: does not supports default-role directive (refs: 3960)
• 3960: default_role = 'guilabel' not functioning
• Missing texinputs_win/Makefile to be used in latexpdf builder on windows.
• 4026: nature: Fix macOS Safari scrollbar color
• 3877: Fix for C++ multiline signatures.
• 4006: Fix crash on parallel build
• 3969: private instance attributes causes AttributeError
• 4041: C++, remove extra name linking in function pointers.
• 4038: C, add missing documentation of member role.
• 4044: An empty multicolumn cell causes extra row height in PDF output
• 4049: Fix typo in output of sphinx-build -h
• 4062: hashlib.sha1() must take bytes, not unicode on Python 3
• Avoid indent after index entries in latex (refs: 4066)
• 4070: crashes when the warning message contains format strings
• 4067: Return non-zero exit status when make subprocess fails
• 4055: graphviz: the :align: option does not work for SVG output
• 4055: graphviz: the :align: center option does not work for latex output
• 4051: warn() function for HTML theme outputs 'None' string

1.6.3

=====================================

Features added

• latex: hint that code-block continues on next page (refs: 3764, 3792)

Bugs fixed

• 3821: Failed to import sphinx.util.compat with docutils-0.14rc1
• 3829: sphinx-quickstart template is incomplete regarding use of alabaster
• 3772: 'str object' has no attribute 'filename'
• Emit wrong warnings if citation label includes hyphens (refs: 3565)
• 3858: Some warnings are not colored when using --color option
• 3775: Remove unwanted whitespace in default template
• 3835: sphinx.ext.imgmath fails to convert SVG images if project directory
  name contains spaces
• 3850: Fix color handling in make mode's help command
• 3865: use of self.env.warn in sphinx extension fails
• 3824: production lists apply smart quotes transform since Sphinx 1.6.1
• latex: fix \sphinxbfcode swallows initial space of argument
• 3878: Quotes in auto-documented class attributes should be straight quotes
  in PDF output
• 3881: LaTeX figure floated to next page sometimes leaves extra vertical
  whitespace
• 3885: duplicated footnotes raises IndexError
• 3873: Failure of deprecation warning mechanism of
  sphinx.util.compat.Directive
• 3874: Bogus warnings for "citation not referenced" for cross-file citations
• 3860: Don't download images when builders not supported images
• 3860: Remote image URIs without filename break builders not supported remote
  images
• 3833: command line messages are translated unintentionally with language
  setting.
• 3840: make checking epub_uid strict
• 3851, 3706: Fix about box drawing characters for PDF output
• 3900: autosummary could not find methods
• 3902: Emit error if latex_documents contains non-unicode string in py2

1.6.2

=====================================

Incompatible changes

• 3789: Do not require typing module for python>=3.5

Bugs fixed

• 3754: HTML builder crashes if HTML theme appends own stylesheets
• 3756: epub: Entity 'mdash' not defined
• 3758: Sphinx crashed if logs are emitted in conf.py
• 3755: incorrectly warns about dedent with literalinclude
• 3742: RTD <https://readthedocs.org/>_ PDF builds of Sphinx own docs are
  missing an index entry in the bookmarks and table of contents. This is
  rtfd/readthedocs.org2857 <https://github.com/rtfd/readthedocs.org/issues/2857>_ issue, a workaround
  is obtained using some extra LaTeX code in Sphinx's own :file:conf.py
• 3770: Build fails when a "code-block" has the option emphasize-lines and the
  number indicated is higher than the number of lines
• 3774: Incremental HTML building broken when using citations
• 3763: got epubcheck validations error if epub_cover is set
• 3779: 'ImportError' in sphinx.ext.autodoc due to broken 'sys.meta_path'.
  Thanks to Tatiana Tereshchenko.
• 3796: env.resolve_references() crashes when non-document node given
• 3803: Sphinx crashes with invalid PO files
• 3791: PDF "continued on next page" for long tables isn't internationalized
• 3788: smartquotes emits warnings for unsupported languages
• 3807: latex Makefile for make latexpdf is only for unixen
• 3781: double hyphens in option directive are compiled as endashes
• 3817: latex builder raises AttributeError

1.6.1

=====================================

Dependencies

1.6

• LDML format support in i18n feature
• sphinx.addnodes.termsep
• Some functions and classes in sphinx.util.pycompat:
  zip_longest, product, all, any, next, open,
  class_types, base_exception, relpath, StringIO, BytesIO.
  Please use the standard library version instead;

If any deprecation warning like RemovedInSphinxXXXWarning are displayed,
please refer :ref:when-deprecation-warnings-are-displayed.

Features added

1.6b3

• 3588: No compact (p tag) html output in the i18n document build even when
  :confval:html_compact_lists is True.
• The make latexpdf from 1.6b1 (for GNU/Linux and Mac OS, using
  latexmk) aborted earlier in case of LaTeX errors than was the case with
  1.5 series, due to hard-coded usage of --halt-on-error option. (refs 3695)
• 3683: sphinx.websupport module is not provided by default
• 3683: Failed to build document if builder.css_file.insert() is called
• 3714: viewcode extension not taking highlight_code='none' in account
• 3698: Moving :doc: to std domain broke backwards compatibility
• 3633: misdetect unreferenced citations

1.6b2

• 3662: builder.css_files is deprecated. Please use add_stylesheet()
  API instead.

1.6b1

• sphinx.util.compat.Directive class is now deprecated. Please use instead
  docutils.parsers.rst.Directive
• sphinx.util.compat.docutils_version is now deprecated
• 2367: Sphinx.warn(), Sphinx.info() and other logging methods are now
  deprecated. Please use sphinx.util.logging (:ref:logging-api) instead.
• 3318: notice is now deprecated as LaTeX environment name and will be
  removed at Sphinx 1.7. Extension authors please use sphinxadmonition
  instead (as Sphinx does since 1.5.)
• Sphinx.status_iterator() and Sphinx.old_status_iterator() is now
  deprecated. Please use sphinx.util:status_iterator() instead.
• Sphinx._directive_helper() is deprecated. Please use
  sphinx.util.docutils.directive_helper() instead.
• BuildEnvironment.set_warnfunc() is now deprecated
• Following methods of BuildEnvironment is now deprecated.

• BuildEnvironment.note_toctree()
• BuildEnvironment.get_toc_for()
• BuildEnvironment.get_toctree_for()
• BuildEnvironment.create_index()

Please use sphinx.environment.adapters modules instead.

• latex package footnote is not loaded anymore by its bundled replacement
  footnotehyper-sphinx. The redefined macros keep the same names as in the
  original package.
• 3429: deprecate config setting latex_keep_old_macro_names. It will be
  removed at 1.7, and already its default value has changed from True to
  False.
• 3221: epub2 builder is deprecated
• 3254: sphinx.websupport is now separated into independent package;
  sphinxcontrib-websupport. sphinx.websupport will be removed in
  Sphinx-2.0.
• 3628: sphinx_themes entry_point is deprecated. Please use
  sphinx.html_themes instead.

1.5.6

=====================================

Bugs fixed

• 3614: Sphinx crashes with requests-2.5.0
• 3618: autodoc crashes with tupled arguments
• 3664: No space after the bullet in items of a latex list produced by Sphinx
• 3657: EPUB builder crashes if document startswith genindex exists
• 3588: No compact (p tag) html output in the i18n document build even when
  :confval:html_compact_lists is True.
• 3685: AttributeError when using 3rd party domains
• 3702: LaTeX writer styles figure legends with a hard-coded \small
• 3708: LaTeX writer allows irc scheme
• 3717: Stop enforcing that favicon's must be .ico
• 3731, 3732: Protect isenumclass predicate against non-class arguments
• 3320: Warning about reference target not being found for container types
• Misspelled ARCHIVEPREFIX in Makefile for latex build repertory

Got merge conflicts? Close this PR and delete the branch. I'll create a new PR for you.

Happy merging! 🤖