Merge #1

1: Initial Update r=aragilar a=pyup-bot



This PR sets up pyup.io on this repo and updates all dependencies at once, in a single branch.

Subsequent pull requests will update one dependency at a time, each in their own branch. If you want to start with that right away, simply close this PR.





### Update [bpython](https://pypi.org/project/bpython) from **0.18** to **0.18**.


*The bot wasn't able to find a changelog for this release. [Got an idea?](https://github.com/pyupio/changelogs/issues/new)*

<details>
  <summary>Links</summary>
  
  - PyPI: https://pypi.org/project/bpython
  - Homepage: http://www.bpython-interpreter.org/
</details>





### Update [ipython[all]](https://pypi.org/project/ipython) from **7.8.0** to **7.8.0**.


<details>
  <summary>Changelog</summary>
  
  
   ### 7.8.0
   ```
   None
   ```
   
  
  
   ### 7.7.0
   ```
   None
   ```
   
  
  
   ### 7.6.1
   ```
   None
   ```
   
  
  
   ### 7.6.0
   ```
   None
   ```
   
  
  
   ### 7.5.0
   ```
   None
   ```
   
  
  
   ### 7.4.0
   ```
   None
   ```
   
  
  
   ### 7.3.0
   ```
   None
   ```
   
  
  
   ### 7.2.0
   ```
   None
   ```
   
  
  
   ### 7.1.1
   ```
   None
   ```
   
  
  
   ### 7.1.0
   ```
   None
   ```
   
  
  
   ### 7.0.1
   ```
   None

7.0.0-doc
None
   ```
   
  
  
   ### 7.0.0
   ```
   None
   ```
   
  
  
   ### 7.0.0rc1
   ```
   None
   ```
   
  
  
   ### 7.0.0b1
   ```
   None
   ```
   
  
  
   ### 6.2.1
   ```
   None
   ```
   
  
  
   ### 6.2.0
   ```
   None
   ```
   
  
  
   ### 6.1.0
   ```
   None
   ```
   
  
  
   ### 6.0.0
   ```
   None
   ```
   
  
  
   ### 6.0.0rc1
   ```
   None

rel-3.0.0
See the [release notes](http://ipython.org/ipython-doc/3/whatsnew/version3.htmlrelease-3-0) for what&#39;s new.

or get it with pip:


pip install --upgrade &quot;ipython[all]&quot;


DO NOT download from the &quot;Source code&quot; links below. They are missing git submodules, and won&#39;t work.


rel-2.4.1


rel-2.1.0
bugfix release for IPython 2.0. See the [list of backported fixes](http://ipython.org/ipython-doc/2/whatsnew/github-stats-2.0.html).


rel-1.2.1
Bugfix release for Python 2.6 and 3.4.

[What&#39;s new in 1.2](http://ipython.org/ipython-doc/1/whatsnew/github-stats-1.0.htmlissues-closed-in-1-2)


rel-1.2.0
IPython 1.2.0 mostly bugfix release

For release notes, see [what&#39;s new](http://ipython.org/ipython-doc/rel-1.2.0/whatsnew/github-stats-1.0.html).


rel-1.1.0
   ```
   
  
  
   ### 1.0
   ```
   Patches backported to IPython 1.1.0 (2013/08/08 - 2013/09/09)

These lists are automatically generated, and may be incomplete or contain duplicates.

The following 25 authors contributed 337 commits.
- Benjamin Ragan-Kelley
- Bing Xia
- Bradley M. Froehle
- Brian E. Granger
- Damián Avila
- dhirschfeld
- Dražen Lučanin
- gmbecker
- Jake Vanderplas
- Jason Grout
- Jonathan Frederic
- Kevin Burke
- Kyle Kelley
- Matt Henderson
- Matthew Brett
- Matthias Bussonnier
- Pankaj Pandey
- Paul Ivanov
- rossant
- Samuel Ainsworth
- Stephan Rave
- stonebig
- Thomas Kluyver
- Yaroslav Halchenko
- Zachary Sailer

We closed a total of 76 issues, 58 pull requests and 18 regular issues;
this is the full list (generated with the script :file:`tools/github_stats.py`):

Pull Requests (58):
- PR 4188 - Allow user_ns trait to be None
- PR 4189 - always fire LOCAL_IPS.extend(PUBLIC_IPS)
- PR 4174 - various issues in markdown and rst templates
- PR 4178 - add missing data_javascript
- PR 4181 - nbconvert: Fix, sphinx template not removing new lines from headers
- PR 4043 - don&#39;t &#39;restore_bytes&#39; in from_JSON
- PR 4163 - Fix for incorrect default encoding on Windows.
- PR 4136 - catch javascript errors in any output
- PR 4171 - add nbconvert config file when creating profiles
- PR 4125 - Basic exercise of `ipython [subcommand] -h` and help-all
- PR 4085 - nbconvert: Fix sphinx preprocessor date format string for Windows
- PR 4159 - don&#39;t split `.cell` and `div.cell` CSS
- PR 4158 - generate choices for `--gui` configurable from real mapping
- PR 4065 - do not include specific css in embedable one
- PR 4092 - nbconvert: Fix for unicode html headers, Windows + Python 2.x
- PR 4074 - close Client sockets if connection fails
- PR 4064 - Store default codemirror mode in only 1 place
- PR 4104 - Add way to install MathJax to a particular profile
- PR 4144 - help_end transformer shouldn&#39;t pick up ? in multiline string
- PR 4143 - update example custom.js
- PR 4142 - DOC: unwrap openssl line in public_server doc
- PR 4141 - add files with a separate `add` call in backport_pr
- PR 4137 - Restore autorestore option for storemagic
- PR 4098 - pass profile-dir instead of profile name to Kernel
- PR 4120 - support `input` in Python 2 kernels
- PR 4088 - nbconvert: Fix coalescestreams line with incorrect nesting causing strange behavior
- PR 4060 - only strip continuation prompts if regular prompts seen first
- PR 4132 - Fixed name error bug in function safe_unicode in module py3compat.
- PR 4121 - move test_kernel from IPython.zmq to IPython.kernel
- PR 4118 - ZMQ heartbeat channel: catch EINTR exceptions and continue.
- PR 4054 - use unicode for HTML export
- PR 4106 - fix a couple of default block values
- PR 4115 - Update docs on declaring a magic function
- PR 4101 - restore accidentally removed EngineError
- PR 4096 - minor docs changes
- PR 4056 - respect `pylab_import_all` when `--pylab` specified at the command-line
- PR 4091 - Make Qt console banner configurable
- PR 4086 - fix missing errno import
- PR 4030 - exclude `.git` in MANIFEST.in
- PR 4047 - Use istype() when checking if canned object is a dict
- PR 4031 - don&#39;t close_fds on Windows
- PR 4029 - bson.Binary moved
- PR 4035 - Fixed custom jinja2 templates being ignored when setting template_path
- PR 4026 - small doc fix in nbconvert
- PR 4016 - Fix IPython.start_\* functions
- PR 4021 - Fix parallel.client.View map() on numpy arrays
- PR 4022 - DOC: fix links to matplotlib, notebook docs
- PR 4018 - Fix warning when running IPython.kernel tests
- PR 4019 - Test skipping without unicode paths
- PR 4008 - Transform code before %prun/%%prun runs
- PR 4014 - Fix typo in ipapp
- PR 3987 - get files list in backport_pr
- PR 3974 - nbconvert: Fix app tests on Window7 w/ Python 3.3
- PR 3978 - fix `--existing` with non-localhost IP
- PR 3939 - minor checkpoint cleanup
- PR 3981 - BF: fix nbconvert rst input prompt spacing
- PR 3960 - Don&#39;t make sphinx a dependency for importing nbconvert
- PR 3973 - logging.Formatter is not new-style in 2.6

Issues (18):
- 4024 - nbconvert markdown issues
- 4095 - Catch js error in append html in stream/pyerr
- 4156 - Specifying --gui=tk at the command line
- 3818 - nbconvert can&#39;t handle Heading with Chinese characters on Japanese Windows OS.
- 4134 - multi-line parser fails on &#39;&#39;&#39; in comment, qtconsole and notebook.
- 3998 - sample custom.js needs to be updated
- 4078 - StoreMagic.autorestore not working in 1.0.0
- 3990 - Buitlin `input` doesn&#39;t work over zmq
- 4015 - nbconvert fails to convert all the content of a notebook
- 4059 - Issues with Ellipsis literal in Python 3
- 4103 - Wrong default argument of DirectView.clear
- 4100 - parallel.client.client references undefined error.EngineError
- 4005 - IPython.start_kernel doesn&#39;t work.
- 4020 - IPython parallel map fails on numpy arrays
- 3945 - nbconvert: commandline tests fail Win7x64 Py3.3
- 3977 - unable to complete remote connections for two-process 
- 3980 - nbconvert rst output lacks needed blank lines
- 3968 - TypeError: super() argument 1 must be type, not classobj (Python 2.6.6)


rel-1.0.0
IPython provides a rich toolkit to help you make the most out of using Python
interactively.  Its main components are:
- Powerful interactive Python shells (terminal- and Qt-based).
- A web-based interactive notebook environment with all shell features plus
  support for embedded figures, animations and rich media.
- Support for interactive data visualization and use of GUI toolkits.
- Flexible, embeddable interpreters to load into your own projects.
- A high-performance library for high level and interactive parallel computing
  that works in multicore systems, clusters, supercomputing and cloud scenarios.

The enhanced interactive Python shells have the following main features:
- Comprehensive object introspection.
- Input history, persistent across sessions.
- Caching of output results during a session with automatically generated
  references.
- Extensible tab completion, with support by default for completion of python
  variables and keywords, filenames and function keywords.
- Extensible system of &#39;magic&#39; commands for controlling the environment and
  performing many tasks related either to IPython or the operating system.
- A rich configuration system with easy switching between different setups
  (simpler than changing $PYTHONSTARTUP environment variables every time).
- Session logging and reloading.
- Extensible syntax processing for special purpose situations.
- Access to the system shell with user-extensible alias system.
- Easily embeddable in other Python programs and GUIs.
- Integrated access to the pdb debugger and the Python profiler.

The parallel computing architecture has the following main features:
- Quickly parallelize Python code from an interactive Python/IPython session.
- A flexible and dynamic process model that be deployed on anything from
  multicore workstations to supercomputers.
- An architecture that supports many different styles of parallelism, from
  message passing to task farming.
- Both blocking and fully asynchronous interfaces.
- High level APIs that enable many things to be parallelized in a few lines
  of code.
- Share live parallel jobs with other users securely.
- Dynamically load balanced task farming system.
- Robust error handling in parallel code.

The latest development version is always available from IPython&#39;s [GitHub
site](http://github.com/ipython).
   ```
   
  
</details>


 

<details>
  <summary>Links</summary>
  
  - PyPI: https://pypi.org/project/ipython
  - Changelog: https://pyup.io/changelogs/ipython/
  - Homepage: https://ipython.org
</details>





### Update [sphinx](https://pypi.org/project/sphinx) from **2.2.0** to **2.2.0**.


<details>
  <summary>Changelog</summary>
  
  
   ### 2.2.0
   ```
   =====================================

Incompatible changes
--------------------

* apidoc: template files are renamed to ``.rst_t``
* html: Field lists will be styled by grid layout

Deprecated
----------

* ``sphinx.domains.math.MathDomain.add_equation()``
* ``sphinx.domains.math.MathDomain.get_next_equation_number()``
* The ``info`` and ``warn`` arguments of
  ``sphinx.ext.autosummary.generate.generate_autosummary_docs()``
* ``sphinx.ext.autosummary.generate._simple_info()``
* ``sphinx.ext.autosummary.generate._simple_warn()``
* ``sphinx.ext.todo.merge_info()``
* ``sphinx.ext.todo.process_todo_nodes()``
* ``sphinx.ext.todo.process_todos()``
* ``sphinx.ext.todo.purge_todos()``

Features added
--------------

* 5124: graphviz: ``:graphviz_dot:`` option is renamed to ``:layout:``
* 1464: html: emit a warning if :confval:`html_static_path` and
  :confval:`html_extra_path` directories are inside output directory
* 6514: html: Add a label to search input for accessability purposes
* 5602: apidoc: Add ``--templatedir`` option
* 6475: Add ``override`` argument to ``app.add_autodocumenter()``
* 6310: imgmath: let :confval:`imgmath_use_preview` work also with the SVG
  format for images rendering inline math
* 6533: LaTeX: refactor visit_enumerated_list() to use ``\sphinxsetlistlabels``
* 6628: quickstart: Use ``https://docs.python.org/3/`` for default setting of
  :confval:`intersphinx_mapping`
* 6419: sphinx-build: give reasons why rebuilded

Bugs fixed
----------

* py domain: duplicated warning does not point the location of source code
* 6499: html: Sphinx never updates a copy of :confval:`html_logo` even if
  original file has changed
* 1125: html theme: scrollbar is hard to see on classic theme and macOS
* 5502: linkcheck: Consider HTTP 503 response as not an error
* 6439: Make generated download links reproducible
* 6486: UnboundLocalError is raised if broken extension installed
* 6567: autodoc: :confval:`autodoc_inherit_docstrings` does not effect to
  ``__init__()`` and ``__new__()``
* 6574: autodoc: :confval:`autodoc_member_order` does not refer order of
  imports when ``&#39;bysource&#39;`` order
* 6574: autodoc: missing type annotation for variadic and keyword parameters
* 6589: autodoc: Formatting issues with autodoc_typehints=&#39;none&#39;
* 6605: autodoc: crashed when target code contains custom method-like objects
* 6498: autosummary: crashed with wrong autosummary_generate setting
* 6507: autosummary: crashes without no autosummary_generate setting
* 6511: LaTeX: autonumbered list can not be customized in LaTeX
  since Sphinx 1.8.0 (refs: 6533)
* 6531: Failed to load last environment object when extension added
* 736: Invalid sort in pair index
* 6527: :confval:`last_updated` wrongly assumes timezone as UTC
* 5592: std domain: :rst:dir:`option` directive registers an index entry for
  each comma separated option
* 6549: sphinx-build: Escaped characters in error messages
* 6545: doctest comments not getting trimmed since Sphinx 1.8.0
* 6561: glossary: Wrong hyperlinks are generated for non alphanumeric terms
* 6620: i18n: classifiers of definition list are not translated with
  docutils-0.15
* 6474: ``DocFieldTransformer`` raises AttributeError when given directive is
  not a subclass of ObjectDescription
   ```
   
  
  
   ### 2.1.2
   ```
   =====================================

Bugs fixed
----------

* 6497: custom lexers fails highlighting when syntax error
* 6478, 6488: info field lists are incorrectly recognized
   ```
   
  
  
   ### 2.1.1
   ```
   =====================================

Incompatible changes
--------------------

* 6447: autodoc: Stop to generate document for undocumented module variables

Bugs fixed
----------

* 6442: LaTeX: admonitions of :rst:dir:`note` type can get separated from
  immediately preceding section title by pagebreak
* 6448: autodoc: crashed when autodocumenting classes with ``__slots__ = None``
* 6451: autodoc: generates docs for &quot;optional import&quot;ed modules as variables
* 6452: autosummary: crashed when generating document of properties
* 6455: napoleon: docstrings for properties are not processed
* 6436: napoleon: &quot;Unknown target name&quot; error if variable name ends with
  underscore
* 6440: apidoc: missing blank lines between modules
   ```
   
  
  
   ### 2.1.0
   ```
   =====================================

Incompatible changes
--------------------

* Ignore filenames without file extension given to ``Builder.build_specific()``
  API directly
* 6230: The anchor of term in glossary directive is changed if it is consisted
  by non-ASCII characters
* 4550: html: Centering tables by default using CSS
* 6239: latex: xelatex and xeCJK are used for Chinese documents by default
* ``Sphinx.add_lexer()`` now takes a Lexer class instead of instance.  An
  instance of lexers are still supported until Sphinx-3.x.

Deprecated
----------

* ``sphinx.builders.latex.LaTeXBuilder.apply_transforms()``
* ``sphinx.builders._epub_base.EpubBuilder.esc()``
* ``sphinx.directives.Acks``
* ``sphinx.directives.Author``
* ``sphinx.directives.Centered``
* ``sphinx.directives.Class``
* ``sphinx.directives.CodeBlock``
* ``sphinx.directives.Figure``
* ``sphinx.directives.HList``
* ``sphinx.directives.Highlight``
* ``sphinx.directives.Include``
* ``sphinx.directives.Index``
* ``sphinx.directives.LiteralInclude``
* ``sphinx.directives.Meta``
* ``sphinx.directives.Only``
* ``sphinx.directives.SeeAlso``
* ``sphinx.directives.TabularColumns``
* ``sphinx.directives.TocTree``
* ``sphinx.directives.VersionChange``
* ``sphinx.domains.python.PyClassmember``
* ``sphinx.domains.python.PyModulelevel``
* ``sphinx.domains.std.StandardDomain._resolve_citation_xref()``
* ``sphinx.domains.std.StandardDomain.note_citations()``
* ``sphinx.domains.std.StandardDomain.note_citation_refs()``
* ``sphinx.domains.std.StandardDomain.note_labels()``
* ``sphinx.environment.NoUri``
* ``sphinx.ext.apidoc.format_directive()``
* ``sphinx.ext.apidoc.format_heading()``
* ``sphinx.ext.apidoc.makename()``
* ``sphinx.ext.autodoc.importer.MockFinder``
* ``sphinx.ext.autodoc.importer.MockLoader``
* ``sphinx.ext.autodoc.importer.mock()``
* ``sphinx.ext.autosummary.autolink_role()``
* ``sphinx.ext.imgmath.DOC_BODY``
* ``sphinx.ext.imgmath.DOC_BODY_PREVIEW``
* ``sphinx.ext.imgmath.DOC_HEAD``
* ``sphinx.transforms.CitationReferences``
* ``sphinx.transforms.SmartQuotesSkipper``
* ``sphinx.util.docfields.DocFieldTransformer.preprocess_fieldtypes()``
* ``sphinx.util.node.find_source_node()``
* ``sphinx.util.i18n.find_catalog()``
* ``sphinx.util.i18n.find_catalog_files()``
* ``sphinx.util.i18n.find_catalog_source_files()``

For more details, see :ref:`deprecation APIs list &lt;dev-deprecated-apis&gt;`.

Features added
--------------

* Add a helper class ``sphinx.transforms.post_transforms.SphinxPostTransform``
* Add helper methods

  - ``PythonDomain.note_module()``
  - ``PythonDomain.note_object()``
  - ``SphinxDirective.set_source_info()``

* 6180: Support ``--keep-going`` with BuildDoc setup command
* ``math`` directive now supports ``:class:`` option
* todo: ``todo`` directive now supports ``:name:`` option
* Enable override via environment of ``SPHINXOPTS`` and ``SPHINXBUILD`` Makefile
  variables (refs: 6232, 6303)
* 6287: autodoc: Unable to document bound instance methods exported as module
  functions
* 6289: autodoc: :confval:`autodoc_default_options` now supports
  ``imported-members`` option
* 4777: autodoc: Support coroutine
* 744: autodoc: Support abstractmethod
* 6325: autodoc: Support attributes in __slots__.  For dict-style __slots__,
  autodoc considers values as a docstring of the attribute
* 6361: autodoc: Add :confval:`autodoc_typehints` to suppress typehints from
  signature
* 1063: autodoc: ``automodule`` directive now handles undocumented module level
  variables
* 6212 autosummary: Add :confval:`autosummary_imported_members` to display
  imported members on autosummary
* 6271: ``make clean`` is catastrophically broken if building into &#39;.&#39;
* 6363: Support ``%O%`` environment variable in make.bat
* 4777: py domain: Add ``:async:`` option to :rst:dir:`py:function` directive
* py domain: Add new options to :rst:dir:`py:method` directive

  - ``:abstractmethod:``
  - ``:async:``
  - ``:classmethod:``
  - ``:property:``
  - ``:staticmethod:``

* rst domain: Add :rst:dir:`directive:option` directive to describe the option
  for directive
* 6306: html: Add a label to search form for accessability purposes
* 4390: html: Consistent and semantic CSS for signatures
* 6358: The ``rawsource`` property of ``production`` nodes now contains the
  full production rule
* 6373: autosectionlabel: Allow suppression of warnings
* coverage: Support a new ``coverage_ignore_pyobjects`` option
* 6239: latex: Support to build Chinese documents

Bugs fixed
----------

* 6230: Inappropriate node_id has been generated by glossary directive if term
  is consisted by non-ASCII characters
* 6213: ifconfig: contents after headings are not shown
* commented term in glossary directive is wrongly recognized
* 6299: rst domain: rst:directive directive generates waste space
* 6379: py domain: Module index (py-modindex.html) has duplicate titles
* 6331: man: invalid output when doctest follows rubric
* 6351: &quot;Hyperlink target is not referenced&quot; message is shown even if
  referenced
* 6165: autodoc: ``tab_width`` setting of docutils has been ignored
* 6347: autodoc: crashes with a plain Tuple on Python 3.6 and 3.5
* 6311: autosummary: autosummary table gets confused by complex type hints
* 6350: autosummary: confused by an argument having some kind of default value
* Generated Makefiles lack a final EOL (refs: 6232)
* 6375: extlinks: Cannot escape angle brackets in link caption
* 6378: linkcheck: Send commonly used User-Agent
* 6387: html search: failed to search document with haiku and scrolls themes
* 6408: html search: Fix the ranking of search results
* 6406: Wrong year is returned for ``SOURCE_DATE_EPOCH``
* 6402: image directive crashes by unknown image format
* 6286: C++, allow 8 and 9 in hexadecimal integer literals.
* 6305: Fix the string in quickstart for &#39;path&#39; argument of parser
* LaTeX: Figures in admonitions produced errors (refs: 6364)
   ```
   
  
  
   ### 2.0.1
   ```
   =====================================

Bugs fixed
----------

* LaTeX: some system labels are not translated
* RemovedInSphinx30Warning is marked as pending
* deprecation warnings are not emitted

  - sphinx.application.CONFIG_FILENAME
  - sphinx.builders.htmlhelp
  - :confval:`viewcode_import`

* 6208: C++, properly parse full xrefs that happen to have a short xref as
  prefix
* 6220, 6225: napoleon: AttributeError is raised for raised section having
  references
* 6245: circular import error on importing SerializingHTMLBuilder
* 6243: LaTeX: &#39;releasename&#39; setting for latex_elements is ignored
* 6244: html: Search function is broken with 3rd party themes
* 6263: html: HTML5Translator crashed with invalid field node
* 6262: html theme: The style of field lists has changed in bizstyle theme
   ```
   
  
  
   ### 2.0.0
   ```
   * 6196: py domain: unexpected prefix is generated

Testing
--------
   ```
   
  
  
   ### 2.0.0b2
   ```
   * Add a helper function: ``sphinx.testing.restructuredtext.parse()``
   ```
   
  
  
   ### 2.0.0b1
   ```
   * Stop to use ``SPHINX_TEST_TEMPDIR`` envvar
   ```
   
  
  
   ### 1.8.5
   ```
   =====================================

Bugs fixed
----------

* LaTeX: Remove extraneous space after author names on PDF title page (refs:
  6004)
* 6026: LaTeX: A cross reference to definition list does not work
* 6046: LaTeX: ``TypeError`` is raised when invalid latex_elements given
* 6067: LaTeX: images having a target are concatenated to next line
* 6067: LaTeX: images having a target are not aligned even if specified
* 6149: LaTeX: ``:index:`` role in titles causes ``Use of \icentercr doesn&#39;t
  match its definition`` error on latexpdf build
* 6019: imgconverter: Including multipage PDF fails
* 6047: autodoc: ``autofunction`` emits a warning for method objects
* 6028: graphviz: Ensure the graphviz filenames are reproducible
* 6068: doctest: ``skipif`` option may remove the code block from documentation
* 6136: ``:name:`` option for ``math`` directive causes a crash
* 6139: intersphinx: ValueError on failure reporting
* 6135: changes: Fix UnboundLocalError when any module found
* 3859: manpage: code-block captions are not displayed correctly
   ```
   
  
  
   ### 1.8.4
   ```
   =====================================

Bugs fixed
----------

* 3707: latex: no bold checkmark (✔) available.
* 5605: with the documentation language set to Chinese, English words could not
  be searched.
* 5889: LaTeX: user ``numfig_format`` is stripped of spaces and may cause
  build failure
* C++, fix hyperlinks for declarations involving east cv-qualifiers.
* 5755: C++, fix duplicate declaration error on function templates with
  constraints in the return type.
* C++, parse unary right fold expressions and binary fold expressions.
* pycode could not handle egg files on windows
* 5928: KeyError: &#39;DOCUTILSCONFIG&#39; when running build
* 5936: LaTeX: PDF build broken by inclusion of image taller than page height
  in an admonition
* 5231: &quot;make html&quot; does not read and build &quot;po&quot; files in &quot;locale&quot; dir
* 5954: ``:scale:`` image option may break PDF build if image in an admonition
* 5966: mathjax has not been loaded on incremental build
* 5960: LaTeX: modified PDF layout since September 2018 TeXLive update of
  :file:`parskip.sty`
* 5948: LaTeX: duplicated labels are generated for sections
* 5958: versionadded directive causes crash with Python 3.5.0
* 5995: autodoc: autodoc_mock_imports conflict with metaclass on Python 3.7
* 5871: texinfo: a section title ``.`` is not allowed
   ```
   
  
  
   ### 1.8.3
   ```
   =====================================

Features added
--------------

* LaTeX: it is possible to insert custom material to appear on back of title
  page, see discussion of ``&#39;maketitle&#39;`` key of :confval:`latex_elements`
  (``&#39;manual&#39;`` docclass only)

Bugs fixed
----------

* 5725: mathjax: Use CDN URL for &quot;latest&quot; version by default
* 5460: html search does not work with some 3rd party themes
* 5520: LaTeX, caption package incompatibility since Sphinx 1.6
* 5614: autodoc: incremental build is broken when builtin modules are imported
* 5627: qthelp: index.html missing in QtHelp
* 5659: linkcheck: crashes for a hyperlink containing multibyte character
* 5754: DOC: Fix some mistakes in :doc:`/latex`
* 5810: LaTeX: sphinxVerbatim requires explicit &quot;hllines&quot; set-up since 1.6.6
  (refs: 1238)
* 5636: C++, fix parsing of floating point literals.
* 5496 (again): C++, fix assertion in partial builds with duplicates.
* 5724: quickstart: sphinx-quickstart fails when $LC_ALL is empty
* 1956: Default conf.py is not PEP8-compliant
* 5849: LaTeX: document class ``\maketitle`` is overwritten with no
  possibility to use original meaning in place of Sphinx custom one
* 5834: apidoc: wrong help for ``--tocfile``
* 5800: todo: crashed if todo is defined in TextElement
* 5846: htmlhelp: convert hex escaping to decimal escaping in .hhc/.hhk files
* htmlhelp: broken .hhk file generated when title contains a double quote
   ```
   
  
  
   ### 1.8.2
   ```
   =====================================

Incompatible changes
--------------------

* 5497: Do not include MathJax.js and jsmath.js unless it is really needed

Features added
--------------

* 5471: Show appropriate deprecation warnings

Bugs fixed
----------

* 5490: latex: enumerated list causes a crash with recommonmark
* 5492: sphinx-build fails to build docs w/ Python &lt; 3.5.2
* 3704: latex: wrong ``\label`` positioning for figures with a legend
* 5496: C++, fix assertion when a symbol is declared more than twice.
* 5493: gettext: crashed with broken template
* 5495: csv-table directive with file option in included file is broken (refs:
  4821)
* 5498: autodoc: unable to find type hints for a ``functools.partial``
* 5480: autodoc: unable to find type hints for unresolvable Forward references
* 5419: incompatible math_block node has been generated
* 5548: Fix ensuredir() in case of pre-existing file
* 5549: graphviz Correctly deal with non-existing static dir
* 3002: i18n: multiple footnote_references referring same footnote cause
  duplicated node_ids
* 5563: latex: footnote_references generated by extension causes a LaTeX
  builder crash
* 5561: make all-pdf fails with old xindy version
* 5557: quickstart: --no-batchfile isn&#39;t honored
* 3080: texinfo: multiline rubrics are broken
* 3080: texinfo: multiline citations are broken
   ```
   
  
  
   ### 1.8.1
   ```
   =====================================

Incompatible changes
--------------------

* LaTeX ``\pagestyle`` commands have been moved to the LaTeX template. No
  changes in PDF, except possibly if ``\sphinxtableofcontents``, which
  contained them, had been customized in :file:`conf.py`. (refs: 5455)

Bugs fixed
----------

* 5418: Incorrect default path for sphinx-build -d/doctrees files
* 5421: autodoc emits deprecation warning for :confval:`autodoc_default_flags`
* 5422: lambda object causes PicklingError on storing environment
* 5417: Sphinx fails to build with syntax error in Python 2.7.5
* 4911: add latexpdf to make.bat for non make-mode
* 5436: Autodoc does not work with enum subclasses with properties/methods
* 5437: autodoc: crashed on modules importing eggs
* 5433: latex: ImportError: cannot import name &#39;DEFAULT_SETTINGS&#39;
* 5431: autodoc: ``autofunction`` emits a warning for callable objects
* 5457: Fix TypeError in error message when override is prohibited
* 5453: PDF builds of &#39;howto&#39; documents have no page numbers
* 5463: mathbase: math_role and MathDirective was disappeared in 1.8.0
* 5454: latex: Index has disappeared from PDF for Japanese documents
* 5432: py domain: ``:type:`` field can&#39;t process ``:term:`` references
* 5426: py domain: TypeError has been raised for class attribute
   ```
   
  
  
   ### 1.8.0
   ```
   =====================================

Dependencies
------------
   ```
   
  
  
   ### 1.8.0b2
   ```
   * html: search box overrides to other elements if scrolled
* i18n: warnings for translation catalogs have wrong line numbers (refs: 5321)
* 5325: latex: cross references has been broken by multiply labeled objects
* C++, fixes for symbol addition and lookup. Lookup should no longer break
  in partial builds. See also 5337.
* 5348: download reference to remote file is not displayed
* 5282: html theme: ``pygments_style`` of theme was overridden by ``conf.py``
  by default
* 4379: toctree shows confusing warning when document is excluded
* 2401: autodoc: ``:members:`` causes ``:special-members:`` not to be shown
* autodoc: ImportError is replaced by AttributeError for deeper module
* 2720, 4034: Incorrect links with ``:download:``, duplicate names, and
  parallel builds
* 5290: autodoc: failed to analyze source code in egg package
* 5399: Sphinx crashes if unknown po file exists
   ```
   
  
  
   ### 1.8.0b1
   ```
   * 5083: Fix wrong make.bat option for internationalization.
* 5115: napoleon: add admonitions added by 4613 to the docs.
   ```
   
  
  
   ### 1.7.9
   ```
   =====================================

Features added
--------------

* 5359: Make generated texinfo files reproducible by sorting the anchors

Bugs fixed
----------

* 5361: crashed on incremental build if document uses include directive
   ```
   
  
  
   ### 1.7.8
   ```
   =====================================

Incompatible changes
--------------------

* The type of ``env.included`` has been changed to dict of set

Bugs fixed
----------

* 5320: intersphinx: crashed if invalid url given
* 5326: manpage: crashed when invalid docname is specified as ``man_pages``
* 5322: autodoc: ``Any`` typehint causes formatting error
* 5327: &quot;document isn&#39;t included in any toctree&quot; warning on rebuild with
  generated files
* 5335: quickstart: escape sequence has been displayed with MacPorts&#39; python
   ```
   
  
  
   ### 1.7.7
   ```
   =====================================

Bugs fixed
----------

* 5198: document not in toctree warning when including files only for parallel
  builds
* LaTeX: reduce &quot;Token not allowed in a PDF string&quot; hyperref warnings in latex
  console output (refs: 5236)
* LaTeX: suppress &quot;remreset Warning: The remreset package is obsolete&quot; in latex
  console output with recent LaTeX (refs: 5237)
* 5234: PDF output: usage of PAPER environment variable is broken since Sphinx
  1.5
* LaTeX: fix the :confval:`latex_engine` documentation regarding Latin Modern
  font with XeLaTeX/LuaLateX (refs: 5251)
* 5280: autodoc: Fix wrong type annotations for complex typing
* autodoc: Optional types are wrongly rendered
* 5291: autodoc crashed by ForwardRef types
* 5211: autodoc: No docs generated for functools.partial functions
* 5306: autodoc: ``getargspec()`` raises NameError for invalid typehints
* 5298: imgmath: math_number_all causes equations to have two numbers in html
* 5294: sphinx-quickstart blank prompts in PowerShell
   ```
   
  
  
   ### 1.7.6
   ```
   =====================================

Bugs fixed
----------

* 5037: LaTeX ``\sphinxupquote{}`` breaks in Russian
* sphinx.testing uses deprecated pytest API; ``Node.get_marker(name)``
* 5016: crashed when recommonmark.AutoStrictify is enabled
* 5022: latex: crashed with docutils package provided by Debian/Ubuntu
* 5009: latex: a label for table is vanished if table does not have a caption
* 5048: crashed with numbered toctree
* 2410: C, render empty argument lists for macros.
* C++, fix lookup of full template specializations with no template arguments.
* 4667: C++, fix assertion on missing references in global scope when using
  intersphinx. Thanks to Alan M. Carroll.
* 5019: autodoc: crashed by Form Feed Character
* 5032: autodoc: loses the first staticmethod parameter for old styled classes
* 5036: quickstart: Typing Ctrl-U clears the whole of line
* 5066: html: &quot;relations&quot; sidebar is not shown by default
* 5091: latex: curly braces in index entries are not handled correctly
* 5070: epub: Wrong internal href fragment links
* 5104: apidoc: Interface of ``sphinx.apidoc:main()`` has changed
* 4272: PDF builds of French projects have issues with XeTeX
* 5076: napoleon raises RuntimeError with python 3.7
* 5125: sphinx-build: Interface of ``sphinx:main()`` has changed
* sphinx-build: ``sphinx.cmd.build.main()`` refers ``sys.argv`` instead of given
  argument
* 5146: autosummary: warning is emitted when the first line of docstring ends
  with literal notation
* autosummary: warnings of autosummary indicates wrong location (refs: 5146)
* 5143: autodoc: crashed on inspecting dict like object which does not support
  sorting
* 5139: autodoc: Enum argument missing if it shares value with another
* 4946: py domain: rtype field could not handle &quot;None&quot; as a type
* 5176: LaTeX: indexing of terms containing `, ``!``, or ``&quot;`` fails
* 5161: html: crashes if copying static files are failed
* 5167: autodoc: Fix formatting type annotations for tuples with more than two
  arguments
* 3329: i18n: crashed by auto-symbol footnote references
* 5158: autosummary: module summary has been broken when it starts with heading
   ```
   
  
  
   ### 1.7.5
   ```
   =====================================

Bugs fixed
----------

* 4924: html search: Upper characters problem in any other languages
* 4932: apidoc: some subpackage is ignored if sibling subpackage contains a
  module starting with underscore
* 4863, 4938, 4939: i18n doesn&#39;t handle correctly node.title as used for
  contents, topic, admonition, table and section.
* 4913: i18n: literal blocks in bullet list are not translated
* 4962: C++, raised TypeError on duplicate declaration.
* 4825: C++, properly parse expr roles and give better error messages when
  (escaped) line breaks are present.
* C++, properly use ``desc_addname`` nodes for prefixes of names.
* C++, parse pack expansions in function calls.
* 4915, 4916: links on search page are broken when using dirhtml builder
* 4969: autodoc: constructor method should not have return annotation
* latex: deeply nested enumerated list which is beginning with non-1 causes
  LaTeX engine crashed
* 4978: latex: shorthandoff is not set up for Brazil locale
* 4928: i18n: Ignore dot-directories like .git/ in LC_MESSAGES/
* 4946: py domain: type field could not handle &quot;None&quot; as a type
* 4979: latex: Incorrect escaping of curly braces in index entries
* 4956: autodoc: Failed to extract document from a subclass of the class on
  mocked module
* 4973: latex: glossary directive adds whitespace to each item
* 4980: latex: Explicit labels on code blocks are duplicated
* 4919: node.asdom() crashes if toctree has :numbered: option
* 4914: autodoc: Parsing error when using dataclasses without default values
* 4931: autodoc: crashed when handler for autodoc-skip-member raises an error
* 4931: autodoc: crashed when subclass of mocked class are processed by
  napoleon module
* 5007: sphinx-build crashes when error log contains a &quot;%&quot; character
   ```
   
  
  
   ### 1.7.4
   ```
   =====================================

Bugs fixed
----------

* 4885, 4887: domains: Crashed with duplicated objects
* 4889: latex: sphinx.writers.latex causes recursive import
   ```
   
  
  
   ### 1.7.3
   ```
   =====================================

Bugs fixed
----------

* 4769: autodoc loses the first staticmethod parameter
* 4790: autosummary: too wide two column tables in PDF builds
* 4795: Latex customization via ``_templates/longtable.tex_t`` is broken
* 4789: imgconverter: confused by convert.exe of Windows
* 4783: On windows, Sphinx crashed when drives of srcdir and outdir are
  different
* 4812: autodoc ignores type annotated variables
* 4817: wrong URLs on warning messages
* 4784: latex: :confval:`latex_show_urls` assigns incorrect footnote numbers if
  hyperlinks exists inside substitutions
* 4837: latex with class memoir Error: Font command ``\sf`` is not supported
* 4803: latex: too slow in proportion to number of auto numbered footnotes
* 4838: htmlhelp: The entries in .hhp file is not ordered
* toctree directive tries to glob for URL having query_string
* 4871: html search: Upper characters problem in German
* 4717: latex: Compilation for German docs failed with LuaLaTeX and XeLaTeX
* 4459: duplicated labels detector does not work well in parallel build
* 4878: Crashed with extension which returns invalid metadata
   ```
   
  
  
   ### 1.7.2
   ```
   =====================================

Incompatible changes
--------------------
* 4520: apidoc: folders with an empty __init__.py are no longer excluded from
  TOC

Bugs fixed
----------

* 4669: sphinx.build_main and sphinx.make_main throw NameError
* 4685: autosummary emits meaningless warnings
* autodoc: crashed when invalid options given
* pydomain: always strip parenthesis if empty (refs: 1042)
* 4689: autosummary: unexpectedly strips docstrings containing &quot;i.e.&quot;
* 4701: viewcode: Misplaced ``&lt;div&gt;`` in viewcode html output
* 4444: Don&#39;t require numfig to use :numref: on sections
* 4727: Option clash for package textcomp
* 4725: Sphinx does not work with python 3.5.0 and 3.5.1
* 4716: Generation PDF file with TexLive on Windows, file not found error
* 4574: vertical space before equation in latex
* 4720: message when an image is mismatched for builder is not clear
* 4655, 4684: Incomplete localization strings in Polish and Chinese
* 2286: Sphinx crashes when error is happens in rendering HTML pages
* 4688: Error to download remote images having long URL
* 4754: sphinx/pycode/__init__.py raises AttributeError
* 1435: qthelp builder should htmlescape keywords
* epub: Fix docTitle elements of toc.ncx is not escaped
* 4520: apidoc: Subpackage not in toc (introduced in 1.6.6) now fixed
* 4767: html: search highlighting breaks mathjax equations
   ```
   
  
  
   ### 1.7.1
   ```
   =====================================

Deprecated
----------

* 4623: ``sphinx.build_main()`` is deprecated.
* autosummary: The interface of ``sphinx.ext.autosummary.get_documenter()`` has
  been changed (Since 1.7.0)
* 4664: ``sphinx.ext.intersphinx.debug()`` is deprecated.

For more details, see `deprecation APIs list
&lt;http://www.sphinx-doc.org/en/master/extdev/index.htmldeprecated-apis&gt;`_

Bugs fixed
----------

* 4608: epub: Invalid meta tag is generated
* 4260: autodoc: keyword only argument separator is not disappeared if it is
  appeared at top of the argument list
* 4622: epub: :confval:`epub_scheme` does not effect to content.opf
* 4627: graphviz: Fit graphviz images to page
* 4617: quickstart: PROJECT_DIR argument is required
* 4623: sphinx.build_main no longer exists in 1.7.0
* 4615: The argument of ``sphinx.build`` has been changed in 1.7.0
* autosummary: The interface of ``sphinx.ext.autosummary.get_documenter()`` has
  been changed
* 4630: Have order on msgids in sphinx.pot deterministic
* 4563: autosummary: Incorrect end of line punctuation detection
* 4577: Enumerated sublists with explicit start with wrong number
* 4641: A external link in TOC cannot contain &quot;?&quot; with ``:glob:`` option
* C++, add missing parsing of explicit casts and typeid in expression parsing.
* C++, add missing parsing of ``this`` in expression parsing.
* 4655: Fix incomplete localization strings in Polish
* 4653: Fix error reporting for parameterless ImportErrors
* 4664: Reading objects.inv fails again
* 4662: ``any`` refs with ``term`` targets crash when an ambiguity is
  encountered
   ```
   
  
  
   ### 1.7.0
   ```
   =====================================

Dependencies
------------
   ```
   
  
  
   ### 1.7.0b3
   ```
   * 4019: inheritance_diagram AttributeError stopping make process
* 4531: autosummary: methods are not treated as attributes
* 4538: autodoc: ``sphinx.ext.autodoc.Options`` has been moved
* 4539: autodoc emits warnings for partialmethods
* 4223: doctest: failing tests reported in wrong file, at wrong line
* i18n: message catalogs are not compiled if specific filenames are given for
  ``sphinx-build`` as arguments (refs: 4560)
* 4027: sphinx.ext.autosectionlabel now expects labels to be the same as they
  are in the raw source; no smart quotes, nothig fancy.
* 4581: apidoc: Excluded modules still included


Testing
--------
   ```
   
  
  
   ### 1.7.0b2
   ```
   * 4415: autodoc classifies inherited classmethods as regular methods
* 4415: autodoc classifies inherited staticmethods as regular methods
* 4472: DOCUMENTATION_OPTIONS is not defined
* 4491: autodoc: prefer _MockImporter over other importers in sys.meta_path
* 4490: autodoc: type annotation is broken with python 3.7.0a4+
* utils package is no longer installed
* 3952: apidoc: module header is too escaped
* 4275: Formats accepted by sphinx.util.i18n.format_date are limited
* 4493: recommonmark raises AttributeError if AutoStructify enabled
* 4209: intersphinx: In link title, &quot;v&quot; should be optional if target has no
  version
* 4230: slowdown in writing pages with sphinx 1.6
* 4522: epub: document is not rebuilt even if config changed
   ```
   
  
  
   ### 1.7.0b1
   ```
   * Add support for docutils 0.14
* Add tests for the ``sphinx.ext.inheritance_diagram`` extension.
   ```
   
  
  
   ### 1.6.7
   ```
   =====================================

Bugs fixed
----------

* 1922: html search: Upper characters problem in French
* 4412: Updated jQuery version from 3.1.0 to 3.2.1
* 4438: math: math with labels with whitespace cause html error
* 2437: make full reference for classes, aliased with &quot;alias of&quot;
* 4434: pure numbers as link targets produce warning
* 4477: Build fails after building specific files
* 4449: apidoc: include &quot;empty&quot; packages that contain modules
* 3917: citation labels are transformed to ellipsis
* 4501: graphviz: epub3 validation error caused if graph is not clickable
* 4514: graphviz: workaround for wrong map ID which graphviz generates
* 4525: autosectionlabel does not support parallel build
* 3953: Do not raise warning when there is a working intersphinx inventory
* 4487: math: ValueError is raised on parallel build. Thanks to jschueller.
* 2372: autosummary: invalid signatures are shown for type annotated functions
* 3942: html: table is not aligned to center even if ``:align: center``
   ```
   
  
  
   ### 1.6.6
   ```
   =====================================

Features added
--------------

* 4181: autodoc: Sort dictionary keys when possible
* ``VerbatimHighlightColor`` is a new
  :ref:`LaTeX &#39;sphinxsetup&#39; &lt;latexsphinxsetup&gt;` 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&#39;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 &#39;howto&#39; documents, ``latex_toplevel_sectioning=&#39;part&#39;``
  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&#39;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&#39;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&#39;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 = &#39;guilabel&#39; 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 &#39;None&#39; 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: &#39;str object&#39; has no attribute &#39;filename&#39;
* 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&#39;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 &quot;citation not referenced&quot; for cross-file citations
* 3860: Don&#39;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&gt;=3.5

Bugs fixed
----------

* 3754: HTML builder crashes if HTML theme appends own stylesheets
* 3756: epub: Entity &#39;mdash&#39; not defined
* 3758: Sphinx crashed if logs are emitted in conf.py
* 3755: incorrectly warns about dedent with literalinclude
* 3742: `RTD &lt;https://readthedocs.org/&gt;`_ PDF builds of Sphinx own docs are
  missing an index entry in the bookmarks and table of contents. This is
  `rtfd/readthedocs.org2857
  &lt;https://github.com/rtfd/readthedocs.org/issues/2857&gt;`_ issue, a workaround
  is obtained using some extra LaTeX code in Sphinx&#39;s own :file:`conf.py`
* 3770: Build fails when a &quot;code-block&quot; 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: &#39;ImportError&#39; in sphinx.ext.autodoc due to broken &#39;sys.meta_path&#39;.
  Thanks to Tatiana Tereshchenko.
* 3796: env.resolve_references() crashes when non-document node given
* 3803: Sphinx crashes with invalid PO files
* 3791: PDF &quot;continued on next page&quot; for long tables isn&#39;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=&#39;none&#39;`` 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 a document starting with 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&#39;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 ``&#39;inputenc&#39;`` 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&#39;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&#39;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&#39;s TOC and bookmarks lack an entry for general Index
  (refs: 3383)
* 3392: ``&#39;releasename&#39;`` in :confval:`latex_elements` is not working
* 3356: Page layout for Japanese ``&#39;manual&#39;`` docclass has a shorter text area
* 3394: When ``&#39;pointsize&#39;`` is not ``10pt``, Japanese ``&#39;manual&#39;`` 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: &amp;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&#39;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 &#39;memoir&#39;
* 3328: Could not refer rubric implicitly
* 3329: emit warnings if po file is invalid and can&#39;t read it. Also writing mo
* 3337: Ugly rendering of definition list term&#39;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 ``&quot;`` 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&#39;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. &quot;-4&quot;)
   ```
   
  
  
   ### 1.5.1
   ```
   =====================================

Features added
--------------

* 3214: Allow to suppress &quot;unknown mimetype&quot; warnings from epub builder using
  :confval:`suppress_warnings`.

Bugs fixed
----------

* 3195: Can not build in parallel
* 3198: AttributeError is raised when toctree has &#39;self&#39;
* 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 (&lt; 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 ``&#39;babel&#39;`` key is set to empty string, LaTeX output contains
  one ``\addto\captions...``
* 3123: user ``&#39;babel&#39;`` 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 &quot;too deeply nested&quot; (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 ``&lt; &gt; -`` 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 &quot;Can&#39;t convert &#39;bytes&#39; object to str implicitly&quot; error
  if linkcheck_anchors enabled
* 3004: Invalid link types &quot;top&quot; and &quot;up&quot; 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 &quot;raw&quot; content if now html
* 3039: English stemmer returns wrong word if the word is capitalized
* Fix make-mode Makefile template (ref 3056, 2936)
   ```
   
  
  …

Author: bors[bot]

dev-requirements.txt

@@ -1,3 +1,3 @@
 # debug tools
-bpython
-ipython[all]
+bpython==0.18
+ipython[all]==7.8.0

doc-requirements.txt

@@ -1 +1 @@
-sphinx
+sphinx==2.2.0