Update sphinx to 1.6.3

[pyup-bot]

There's a new version of sphinx available.
You are currently using 1.4.5. I have updated it to 1.6.3

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

Changelog

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

1.5.5

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

Bugs fixed

• 3597: python domain raises UnboundLocalError if invalid name given
• 3599: Move to new Mathjax CDN

1.5.4

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

Features added

• 3470: Make genindex support all kinds of letters, not only Latin ones

Bugs fixed

• 3445: setting 'inputenc' key to \\usepackage[utf8x]{inputenc} leads
  to failed PDF build
• EPUB file has duplicated nav.xhtml link in content.opf
  except first time build
• 3488: objects.inv has broken when release or version contain
  return code
• 2073, 3443, 3490: gettext builder that writes pot files unless the content
  are same without creation date. Thanks to Yoshiki Shibukawa.
• 3487: intersphinx: failed to refer options
• 3496: latex longtable's last column may be much wider than its contents
• 3507: wrong quotes in latex output for productionlist directive
• 3533: Moving from Sphinx 1.3.1 to 1.5.3 breaks LaTeX compilation of links
  rendered as code
• 2665, 2607: Link names in C++ docfields, and make it possible for other domains.
• 3542: C++, fix parsing error of non-type template argument with template.
• 3065, 3520: python domain fails to recognize nested class
• 3575: Problems with pdflatex in a Turkish document built with sphinx has
  reappeared (refs 2997, 2397)
• 3577: Fix intersphinx debug tool
• A LaTeX command such as \\large inserted in the title items of
  :confval:latex_documents causes failed PDF build (refs 3551, 3567)

1.5.3

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

Features added

• Support requests-2.0.0 (experimental) (refs: 3367)
• (latex) PDF page margin dimensions may be customized (refs: 3387)
• literalinclude directive allows combination of :pyobject: and
  :lines: options (refs: 3416)
• 3400: make-mode doesn't use subprocess on building docs

Bugs fixed

• 3370: the caption of code-block is not picked up for translation
• LaTeX: :confval:release is not escaped (refs: 3362)
• 3364: sphinx-quickstart prompts overflow on Console with 80 chars width
• since 1.5, PDF's TOC and bookmarks lack an entry for general Index
  (refs: 3383)
• 3392: 'releasename' in :confval:latex_elements is not working
• 3356: Page layout for Japanese 'manual' docclass has a shorter text area
• 3394: When 'pointsize' is not 10pt, Japanese 'manual' document
  gets wrong PDF page dimensions
• 3399: quickstart: conf.py was not overwritten by template
• 3366: option directive does not allow punctuations
• 3410: return code in :confval:release breaks html search
• 3427: autodoc: memory addresses are not stripped on Windows
• 3428: xetex build tests fail due to fontspec v2.6 defining \strong
• 3349: Result of IndexBuilder.load() is broken
• 3450: &nbsp is appeared in EPUB docs
• 3418: Search button is misaligned in nature and pyramid theme
• 3421: Could not translate a caption of tables
• 3552: linkcheck raises UnboundLocalError

1.5.2

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

Incompatible changes

• Dependency requirement updates: requests 2.4.0 or above (refs: 3268, 3310)

Features added

• 3241: emit latex warning if buggy titlesec (ref 3210)
• 3194: Refer the $MAKE environment variable to determine make command
• Emit warning for nested numbered toctrees (refs: 3142)
• 978: intersphinx_mapping also allows a list as a parameter
• 3340: (LaTeX) long lines in :dudir:parsed-literal are wrapped like in
  :rst:dir:code-block, inline math and footnotes are fully functional.

Bugs fixed

• 3246: xapian search adapter crashes
• 3253: In Py2 environment, building another locale with a non-captioned
  toctree produces None captions
• 185: References to section title including raw node has broken
• 3255: In Py3.4 environment, autodoc doesn't support documentation for
  attributes of Enum class correctly.
• 3261: latex_use_parts makes sphinx crash
• The warning type misc.highlighting_failure does not work
• 3294: add_latex_package() make crashes non-LaTeX builders
• The caption of table are rendered as invalid HTML (refs: 3287)
• 3268: Sphinx crashes with requests package from Debian jessie
• 3284: Sphinx crashes on parallel build with an extension which raises
  unserializable exception
• 3315: Bibliography crashes on latex build with docclass 'memoir'
• 3328: Could not refer rubric implicitly
• 3329: emit warnings if po file is invalid and can't read it. Also writing mo too
• 3337: Ugly rendering of definition list term's classifier
• 3335: gettext does not extract field_name of a field in a field_list
• 2952: C++, fix refs to operator() functions.
• Fix Unicode super- and subscript digits in :rst:dir:code-block and
  parsed-literal LaTeX output (ref 3342)
• LaTeX writer: leave " character inside parsed-literal as is (ref 3341)
• 3234: intersphinx failed for encoded inventories
• 3158: too much space after captions in PDF output
• 3317: An URL in parsed-literal contents gets wrongly rendered in PDF if
  with hyphen
• LaTeX crash if the filename of an image inserted in parsed-literal
  via a substitution contains an hyphen (ref 3340)
• LaTeX rendering of inserted footnotes in parsed-literal is wrong (ref 3340)
• Inline math in parsed-literal is not rendered well by LaTeX (ref 3340)
• 3308: Parsed-literals don't wrap very long lines with pdf builder (ref 3340)
• 3295: Could not import extension sphinx.builders.linkcheck
• 3285: autosummary: asterisks are escaped twice
• LaTeX, pass dvipdfm option to geometry package for Japanese documents (ref 3363)
• Fix parselinenos() could not parse left half open range (cf. "-4")

1.5.1

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

Features added

• 3214: Allow to suppress "unknown mimetype" warnings from epub builder using
  :confval:suppress_warnings.

Bugs fixed

• 3195: Can not build in parallel
• 3198: AttributeError is raised when toctree has 'self'
• 3211: Remove untranslated sphinx locale catalogs (it was covered by
  untranslated it_IT)
• 3212: HTML Builders crashes with docutils-0.13
• 3207: more latex problems with references inside parsed-literal directive
  (\DUrole)
• 3205: sphinx.util.requests crashes with old pyOpenSSL (< 0.14)
• 3220: KeyError when having a duplicate citation
• 3200: LaTeX: xref inside desc_name not allowed
• 3228: build_sphinx command crashes when missing dependency
• 2469: Ignore updates of catalog files for gettext builder. Thanks to
  Hiroshi Ohkubo.
• 3183: Randomized jump box order in generated index page.

1.5

• 3069: Even if 'babel' key is set to empty string, LaTeX output contains
  one \addto\captions...
• 3123: user 'babel' key setting is not obeyed anymore
• 3155: Fix JavaScript for html_sourcelink_suffix fails with IE and Opera
• 3085: keep current directory after breaking build documentation. Thanks to
  Timotheus Kampik.
• 3181: pLaTeX crashes with a section contains endash
• 3180: latex: add stretch/shrink between successive singleline or
  multipleline cpp signatures (ref 3072)
• 3128: globing images does not support .svgz file
• 3015: fix a broken test on Windows.
• 1843: Fix documentation of descriptor classes that have a custom metaclass.
  Thanks to Erik Bray.
• 3190: util.split_docinfo fails to parse multi-line field bodies
• 3024, 3037: In Python3, application.Sphinx._log crushed when the log message cannot
  be encoded into console encoding.

Testing

• To simplify, sphinx uses external mock package even if unittest.mock exists.

1.5b1

• 2432: Fix unwanted * between varargs and keyword only args. Thanks to Alex Grönholm.
• 3062: Failed to build PDF using 1.5a2 (undefined \hypersetup for
  Japanese documents since PR3030)
• Better rendering of multiline signatures in html.
• 777: LaTeX output "too deeply nested" (ref 3096)
• Let LaTeX image inclusion obey scale before textwidth fit (ref 2865, 3059)
• 3019: LaTeX fails on description of C function with arguments (ref 3083)
• fix latex inline literals where < > - gobbled a space

1.5a2

• 2810: Problems with pdflatex in an Italian document
• Use latex_elements.papersize to specify papersize of LaTeX in Makefile
• 2988: linkcheck: retry with GET request if denied HEAD request
• 2990: linkcheck raises "Can't convert 'bytes' object to str implicitly" error
  if linkcheck_anchors enabled
• 3004: Invalid link types "top" and "up" are used
• 3009: Bad rendering of parsed-literals in LaTeX since Sphinx 1.4.4
• 3000: option directive generates invalid HTML anchors
• 2984: Invalid HTML has been generated if html_split_index enabled
• 2986: themes/basic/defindex.html should be changed for html5 friendly
• 2987: Invalid HTML has been generated if multiple IDs are assigned to a list
• 2891: HTML search does not provide all the results
• 1986: Title in PDF Output
• 147: Problem with latex chapter style
• 3018: LaTeX problem with page layout dimensions and chapter titles
• Fix an issue with \pysigline in LaTeX style file (ref 3023)
• 3038: sphinx.ext.math* raises TypeError if labels are duplicated
• 3031: incompatibility with LaTeX package tocloft
• 3003: literal blocks in footnotes are not supported by Latex
• 3047: spacing before footnote in pdf output is not coherent and allows breaks
• 3045: HTML search index creator should ignore "raw" content if now html
• 3039: English stemmer returns wrong word if the word is capitalized
• Fix make-mode Makefile template (ref 3056, 2936)

1.5a1

• 2707: (latex) the column width is badly computed for tabular
• 2799: Sphinx installs roles and directives automatically on importing sphinx
  module. Now Sphinx installs them on running application.
• sphinx.ext.autodoc crashes if target code imports * from mock modules
  by autodoc_mock_imports.
• 1953: Sphinx.add_node does not add handlers the translator installed by
  html_translator_class
• 1797: text builder inserts blank line on top
• 2894: quickstart main() doesn't use argv argument
• 2874: gettext builder could not extract all text under the only
  directives
• 2485: autosummary crashes with multiple source_suffix values
• 1734: Could not translate the caption of toctree directive
• Could not translate the content of meta directive (ref: 1734)
• 2550: external links are opened in help viewer
• 2687: Running Sphinx multiple times produces 'already registered' warnings

1.4.9

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

Bugs fixed

• 2936: Fix doc/Makefile that can't build man because doc/man exists
• 3058: Using the same 'caption' attribute in multiple 'toctree' directives
  results in warning / error
• 3068: Allow the '=' character in the -D option of sphinx-build.py
• 3074: add_source_parser() crashes in debug mode
• 3135: sphinx.ext.autodoc crashes with plain Callable
• 3150: Fix query word splitter in JavaScript. It behaves as same as Python's regular expression.
• 3093: gettext build broken on substituted images.
• 3093: gettext build broken on image node under note directive.
• imgmath: crashes on showing error messages if image generation failed
• 3117: LaTeX writer crashes if admonition is placed before first section title
• 3164: Change search order of sphinx.ext.inheritance_diagram

1.4.8

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

Bugs fixed

• 2996: The wheel package of Sphinx got crash with ImportError

1.4.7

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

Bugs fixed

• 2890: Quickstart should return an error consistently on all error conditions
• 2870: flatten genindex columns' heights.
• 2856: Search on generated HTML site doesnt find some symbols
• 2882: Fall back to a GET request on 403 status in linkcheck
• 2902: jsdump.loads fails to load search index if keywords starts with
  underscore
• 2900: Fix epub content.opf: add auto generated orphan files to spine.
• 2899: Fix hasdoc() function in Jinja2 template. It can detect genindex, search collectly.
• 2901: Fix epub result: skip creating links from image tags to original image files.
• 2917: inline code is hyphenated on HTML
• 1462: autosummary warns for namedtuple with attribute with trailing underscore
• Could not reference equations if :nowrap: option specified
• 2873: code-block overflow in latex (due to commas)
• 1060, 2056: sphinx.ext.intersphinx: broken links are generated if relative
  paths are used in intersphinx_mapping
• 2931: code-block directive with same :caption: causes warning of duplicate
  target. Now code-block and literalinclude does not define hyperlink
  target using its caption automatially.
• 2962: latex: missing label of longtable
• 2968: autodoc: show-inheritance option breaks docstrings

1.4.6

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

Incompatible changes

• 2867: linkcheck builder crashes with six-1.4. Now Sphinx depends on six-1.5 or
  later

Bugs fixed

• applehelp: Sphinx crashes if hiutil or codesign commands not found
• Fix make clean abort issue when build dir contains regular files like DS_Store.
• Reduce epubcheck warnings/errors:

• Fix DOCTYPE to html5
• Change extension from .html to .xhtml.
• Disable search page on epub results

• 2778: Fix autodoc crashes if obj.dict is a property method and raises exception
• Fix duplicated toc in epub3 output.
• 2775: Fix failing linkcheck with servers not supporting identidy encoding
• 2833: Fix formatting instance annotations in ext.autodoc.
• 1911: -D option of sphinx-build does not override the extensions variable
• 2789: sphinx.ext.intersphinx generates wrong hyperlinks if the inventory is given
• parsing errors for caption of code-blocks are displayed in document (ref: 2845)
• 2846: singlehtml builder does not include figure numbers
• 2816: Fix data from builds cluttering the Domain.initial_data class attributes

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

Happy merging! 🤖

[codecov-io]

Codecov Report

Merging #265 into master will not change coverage.
The diff coverage is n/a.

@@          Coverage Diff          @@
##           master   #265   +/-   ##
=====================================
  Coverage     100%   100%           
=====================================
  Files           5      5           
  Lines          64     64           
=====================================
  Hits           64     64

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 104a0ef...1ea3353. Read the comment docs.