Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update sphinx to 1.8.2 #61

Closed
wants to merge 1 commit into from
Closed

Conversation

pyup-bot
Copy link
Collaborator

This PR updates Sphinx from 1.6.2 to 1.8.2.

Changelog

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 < 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 causes
duplicated node_ids
* 5563: latex: footnote_references generated by extension causes LaTeX builder
crashed
* 5561: make all-pdf fails with old xindy version
* 5557: quickstart: --no-batchfile isn'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 'DEFAULT_SETTINGS'
* 5431: autodoc: ``autofunction`` emits a warning for callable objects
* 5457: Fix TypeError in error message when override is prohibited
* 5453: PDF builds of 'howto' 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'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 overrided by ``conf.py``
by default
* 4379: toctree shows confusible 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.10

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

Dependencies
------------

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

Deprecated
----------

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

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

Testing
--------

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: "document isn't included in any toctree" warning on rebuild with
generated files
* 5335: quickstart: escape sequence has been displayed with MacPorts' python

1.7.7

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

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

* 5198: document not in toctree warning when including files only for parallel
builds
* LaTeX: reduce "Token not allowed in a PDF string" hyperref warnings in latex
console output (refs: 5236)
* LaTeX: suppress "remreset Warning: The remreset package is obsolete" 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: "relations" 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 "None" as a type
* 5176: LaTeX: indexing of terms containing `, ``!``, or ``"`` 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't handle node.title correctly tat 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 "None" 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 "%" character

1.7.4

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

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

* 4885, 4887: domains: Crashed with duplicated objects
* 4889: latex: sphinx.writers.latex causes recusrive 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 "i.e."
* 4701: viewcode: Misplaced ``<div>`` in viewcode html output
* 4444: Don'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
<http://www.sphinx-doc.org/en/master/extdev/index.htmldeprecated-apis>`_

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 "?" 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 stoping 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, "v" 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 "alias of"
* 4434: pure numbers as link targets produce warning
* 4477: Build fails after building specific files
* 4449: apidoc: include "empty" packages that contain modules
* 3917: citation labels are tranformed 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 '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
Links

@pyup-bot pyup-bot mentioned this pull request Nov 11, 2018
@pyup-bot
Copy link
Collaborator Author

Closing this in favor of #68

@pyup-bot pyup-bot closed this Dec 26, 2018
@waynr waynr deleted the pyup-update-sphinx-1.6.2-to-1.8.2 branch December 26, 2018 08:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant