Skip to content

Commit

Permalink
Merge branch '2.0'
Browse files Browse the repository at this point in the history
  • Loading branch information
tk0miya committed Jun 15, 2019
2 parents af50bfc + d2f0c83 commit 5d42659
Show file tree
Hide file tree
Showing 96 changed files with 806 additions and 1,027 deletions.
36 changes: 32 additions & 4 deletions CHANGES
Original file line number Diff line number Diff line change
Expand Up @@ -33,21 +33,33 @@ Incompatible changes
Deprecated
----------

* 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:``

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

* py domain: duplicated warning does not point the location of source code
* #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

Testing
--------

Release 2.1.1 (in development)
Release 2.1.2 (in development)
==============================

Dependencies
Expand All @@ -65,13 +77,29 @@ Features added
Bugs fixed
----------

Testing
--------

Release 2.1.1 (released Jun 10, 2019)
=====================================

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 "optional import"ed modules as variables
* #6452: autosummary: crashed when generating document of properties

Testing
--------
* #6455: napoleon: docstrings for properties are not processed
* #6436: napoleon: "Unknown target name" error if variable name ends with
underscore
* #6440: apidoc: missing blank lines between modules

Release 2.1.0 (released Jun 02, 2019)
=====================================
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -250,7 +250,7 @@ the source and the compiled catalogs.

When a new locale is submitted, add a new directory with the ISO 639-1 language
identifier and put ``sphinx.po`` in there. Don't forget to update the possible
values for :confval:`language` in ``doc/config.rst``.
values for :confval:`language` in ``doc/usage/configuration.rst``.

The Sphinx core messages can also be translated on `Transifex
<https://www.transifex.com/>`_. There exists a client tool named ``tx`` in the
Expand Down
36 changes: 36 additions & 0 deletions doc/extdev/deprecated.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,42 @@ The following is a list of deprecated interfaces.
- (will be) Removed
- Alternatives

* - The ``info`` and ``warn`` arguments of
``sphinx.ext.autosummary.generate.generate_autosummary_docs()``
- 2.2
- 4.0
- ``logging.info()`` and ``logging.warning()``

* - ``sphinx.ext.autosummary.generate._simple_info()``
- 2.2
- 4.0
- ``logging.info()``

* - ``sphinx.ext.autosummary.generate._simple_warn()``
- 2.2
- 4.0
- ``logging.warning()``

* - ``sphinx.ext.todo.merge_info()``
- 2.2
- 4.0
- ``sphinx.ext.todo.TodoDomain``

* - ``sphinx.ext.todo.process_todo_nodes()``
- 2.2
- 4.0
- ``sphinx.ext.todo.TodoDomain``

* - ``sphinx.ext.todo.process_todos()``
- 2.2
- 4.0
- ``sphinx.ext.todo.TodoDomain``

* - ``sphinx.ext.todo.purge_todos()``
- 2.2
- 4.0
- ``sphinx.ext.todo.TodoDomain``

* - ``sphinx.builders.latex.LaTeXBuilder.apply_transforms()``
- 2.1
- 4.0
Expand Down
20 changes: 15 additions & 5 deletions doc/usage/extensions/graphviz.rst
Original file line number Diff line number Diff line change
Expand Up @@ -63,13 +63,17 @@ It adds these directives:
.. versionadded:: 1.1
.. rst:directive:option:: graphviz_dot: dot command of the graph
.. rst:directive:option:: layout: layout type of the graph
:type: text
The graphviz command (ex. ``dot``, ``neato`` and so on) for rendering the
graph. By default, :confval:`graphviz_dot` is used.
The layout of the graph (ex. ``dot``, ``neato`` and so on). A path to the
graphviz commands are also allowed. By default, :confval:`graphviz_dot`
is used.
.. versionadded:: 1.4
.. versionchanged:: 2.2
Renamed from ``graphviz_dot``
.. rst:directive:option:: name: label
:type: text
Expand Down Expand Up @@ -114,10 +118,13 @@ It adds these directives:
.. versionadded:: 1.1
.. rst:directive:option:: graphviz_dot: dot command of the graph
.. rst:directive:option:: layout: layout type of the graph
:type: text
.. versionadded:: 1.4
.. versionchanged:: 2.2
Renamed from ``graphviz_dot``
.. rst:directive:option:: name: label
:type: text
Expand Down Expand Up @@ -156,10 +163,13 @@ It adds these directives:
.. versionadded:: 1.1
.. rst:directive:option:: graphviz_dot: dot command of the graph
.. rst:directive:option:: layout: layout type of the graph
:type: text
.. versionadded:: 1.4
.. versionchanged:: 2.2
Renamed from ``graphviz_dot``
.. rst:directive:option:: name: label
:type: text
Expand Down
3 changes: 0 additions & 3 deletions setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,6 @@ license_file = LICENSE
tag_build = .dev
tag_date = true

[bdist_wheel]
universal = 1

[aliases]
release = egg_info -Db ''
upload = upload --sign --identity=36580288
Expand Down
Loading

0 comments on commit 5d42659

Please sign in to comment.