4041: C++, remove extra name linking in function pointers.
4038: C, add missing documentation of member role.
4044: An empty multicolumn cell causes extra row height in PDF output
4049: Fix typo in output of sphinx-build -h
4062: hashlib.sha1() must take bytes, not unicode on Python 3
Avoid indent after index entries in latex (refs: 4066)
4070: crashes when the warning message contains format strings
4067: Return non-zero exit status when make subprocess fails
4055: graphviz: the :align: option does not work for SVG output
4055: graphviz: the :align: center option does not work for latex output
4051: warn() function for HTML theme outputs 'None' string
1.6.3
=====================================
Features added
latex: hint that code-block continues on next page (refs: 3764, 3792)
Bugs fixed
3821: Failed to import sphinx.util.compat with docutils-0.14rc1
3829: sphinx-quickstart template is incomplete regarding use of alabaster
3772: 'str object' has no attribute 'filename'
Emit wrong warnings if citation label includes hyphens (refs: 3565)
3858: Some warnings are not colored when using --color option
3775: Remove unwanted whitespace in default template
3835: sphinx.ext.imgmath fails to convert SVG images if project directory
name contains spaces
3850: Fix color handling in make mode's help command
3865: use of self.env.warn in sphinx extension fails
3824: production lists apply smart quotes transform since Sphinx 1.6.1
latex: fix \sphinxbfcode swallows initial space of argument
3878: Quotes in auto-documented class attributes should be straight quotes
in PDF output
3881: LaTeX figure floated to next page sometimes leaves extra vertical
whitespace
3885: duplicated footnotes raises IndexError
3873: Failure of deprecation warning mechanism of
sphinx.util.compat.Directive
3874: Bogus warnings for "citation not referenced" for cross-file citations
3860: Don't download images when builders not supported images
3860: Remote image URIs without filename break builders not supported remote
images
3833: command line messages are translated unintentionally with language
setting.
3840: make checking epub_uid strict
3851, 3706: Fix about box drawing characters for PDF output
3900: autosummary could not find methods
3902: Emit error if latex_documents contains non-unicode string in py2
1.6.2
=====================================
Incompatible changes
3789: Do not require typing module for python>=3.5
Bugs fixed
3754: HTML builder crashes if HTML theme appends own stylesheets
3756: epub: Entity 'mdash' not defined
3758: Sphinx crashed if logs are emitted in conf.py
3755: incorrectly warns about dedent with literalinclude
3742: RTD <https://readthedocs.org/> PDF builds of Sphinx own docs are
missing an index entry in the bookmarks and table of contents. This is
rtfd/readthedocs.org2857 <https://github.com/rtfd/readthedocs.org/issues/2857> issue, a workaround
is obtained using some extra LaTeX code in Sphinx's own :file:conf.py
3770: Build fails when a "code-block" has the option emphasize-lines and the
number indicated is higher than the number of lines
3774: Incremental HTML building broken when using citations
3763: got epubcheck validations error if epub_cover is set
3779: 'ImportError' in sphinx.ext.autodoc due to broken 'sys.meta_path'.
Thanks to Tatiana Tereshchenko.
3796: env.resolve_references() crashes when non-document node given
3803: Sphinx crashes with invalid PO files
3791: PDF "continued on next page" for long tables isn't internationalized
3788: smartquotes emits warnings for unsupported languages
3807: latex Makefile for make latexpdf is only for unixen
3781: double hyphens in option directive are compiled as endashes
3817: latex builder raises AttributeError
1.6.1
=====================================
Dependencies
1.6
LDML format support in i18n feature
sphinx.addnodes.termsep
Some functions and classes in sphinx.util.pycompat:
zip_longest, product, all, any, next, open,
class_types, base_exception, relpath, StringIO, BytesIO.
Please use the standard library version instead;
If any deprecation warning like RemovedInSphinxXXXWarning are displayed,
please refer :ref:when-deprecation-warnings-are-displayed.
Features added
1.6b3
3588: No compact (p tag) html output in the i18n document build even when
:confval:html_compact_lists is True.
The make latexpdf from 1.6b1 (for GNU/Linux and Mac OS, using
latexmk) aborted earlier in case of LaTeX errors than was the case with
1.5 series, due to hard-coded usage of --halt-on-error option. (refs 3695)
3683: sphinx.websupport module is not provided by default
3683: Failed to build document if builder.css_file.insert() is called
3714: viewcode extension not taking highlight_code='none' in account
3698: Moving :doc: to std domain broke backwards compatibility
3633: misdetect unreferenced citations
1.6b2
3662: builder.css_files is deprecated. Please use add_stylesheet()
API instead.
1.6b1
sphinx.util.compat.Directive class is now deprecated. Please use instead
docutils.parsers.rst.Directive
sphinx.util.compat.docutils_version is now deprecated
2367: Sphinx.warn(), Sphinx.info() and other logging methods are now
deprecated. Please use sphinx.util.logging (:ref:logging-api) instead.
3318: notice is now deprecated as LaTeX environment name and will be
removed at Sphinx 1.7. Extension authors please use sphinxadmonition
instead (as Sphinx does since 1.5.)
Sphinx.status_iterator() and Sphinx.old_status_iterator() is now
deprecated. Please use sphinx.util:status_iterator() instead.
Sphinx._directive_helper() is deprecated. Please use
sphinx.util.docutils.directive_helper() instead.
BuildEnvironment.set_warnfunc() is now deprecated
Following methods of BuildEnvironment is now deprecated.
BuildEnvironment.note_toctree()
BuildEnvironment.get_toc_for()
BuildEnvironment.get_toctree_for()
BuildEnvironment.create_index()
Please use sphinx.environment.adapters modules instead.
latex package footnote is not loaded anymore by its bundled replacement
footnotehyper-sphinx. The redefined macros keep the same names as in the
original package.
3429: deprecate config setting latex_keep_old_macro_names. It will be
removed at 1.7, and already its default value has changed from True to
False.
3221: epub2 builder is deprecated
3254: sphinx.websupport is now separated into independent package;
sphinxcontrib-websupport. sphinx.websupport will be removed in
Sphinx-2.0.
3628: sphinx_themes entry_point is deprecated. Please use
sphinx.html_themes instead.
1.5.6
=====================================
Bugs fixed
3614: Sphinx crashes with requests-2.5.0
3618: autodoc crashes with tupled arguments
3664: No space after the bullet in items of a latex list produced by Sphinx
3657: EPUB builder crashes if document startswith genindex exists
3588: No compact (p tag) html output in the i18n document build even when
:confval:html_compact_lists is True.
3685: AttributeError when using 3rd party domains
3702: LaTeX writer styles figure legends with a hard-coded \small
3708: LaTeX writer allows irc scheme
3717: Stop enforcing that favicon's must be .ico
3731, 3732: Protect isenumclass predicate against non-class arguments
3320: Warning about reference target not being found for container types
Misspelled ARCHIVEPREFIX in Makefile for latex build repertory
Got merge conflicts? Close this PR and delete the branch. I'll create a new PR for you.
There's a new version of Sphinx available. You are currently using 1.5.5. I have updated it to 1.6.5
These links might come in handy: PyPI | Changelog | Homepage
Changelog
Got merge conflicts? Close this PR and delete the branch. I'll create a new PR for you.
Happy merging! 🤖