Skip to content

Commit 7357b17

Browse files
tk0miyatk0miya
committed
Merge branch '4.x' into 9623_suppress_warnings_for_excluded_document_in_toctree
2 parents 22bec4f + 563936b commit 7357b17

File tree

229 files changed

+11109
-9827
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

229 files changed

+11109
-9827
lines changed

‎.github/workflows/docutils-latest.yml‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: Test with the HEAD of docutils
2+
3+
on:
4+
schedule:
5+
- cron: "0 0 * * SUN"
6+
workflow_dispatch:
7+
8+
jobs:
9+
test:
10+
runs-on: ubuntu-latest
11+
12+
steps:
13+
- uses: actions/checkout@v2
14+
- name: Set up Python
15+
uses: actions/setup-python@v2
16+
- name: Check Python version
17+
run: python --version
18+
- name: Unpin docutils
19+
run: sed -i -e "s/'docutils>=.*'/'docutils'/" setup.py
20+
- name: Install graphviz
21+
run: sudo apt-get install graphviz
22+
- name: Install dependencies
23+
run: pip install -U tox codecov
24+
- name: Run Tox
25+
run: tox -e du-latest -- -vv

‎.github/workflows/main.yml‎

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ jobs:
88
strategy:
99
fail-fast: false
1010
matrix:
11-
name: [py36, py37, py38, py39]
11+
name: [py36, py37, py38, py39, py310]
1212
include:
1313
- name: py36
1414
python: 3.6
@@ -23,9 +23,12 @@ jobs:
2323
python: 3.9
2424
docutils: du17
2525
coverage: "--cov ./ --cov-append --cov-config setup.cfg"
26-
- name: py310-dev
27-
python: 3.10-dev
26+
- name: py310
27+
python: "3.10"
2828
docutils: du17
29+
- name: py311-dev
30+
python: 3.11-dev
31+
docutils: py311
2932
env:
3033
PYTEST_ADDOPTS: ${{ matrix.coverage }}
3134

@@ -47,6 +50,9 @@ jobs:
4750
run: sudo apt-get install graphviz
4851
- name: Install dependencies
4952
run: pip install -U tox codecov
53+
- name: Install the latest py package (for py3.11-dev)
54+
run: pip install -U git+https://github.com/pytest-dev/py
55+
if: ${{ matrix.python == '3.11-dev' }}
5056
- name: Run Tox
5157
run: tox -e ${{ matrix.docutils }} -- -vv
5258
- name: codecov

‎.github/workflows/transifex.yml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ jobs:
1515
ref: 4.x
1616
- name: Set up Python
1717
uses: actions/setup-python@v2
18+
with:
19+
python-version: 3.9 # https://github.com/transifex/transifex-client/pull/330
1820
- name: Install dependencies
1921
run: pip install -U babel jinja2 transifex-client
2022
- name: Extract translations from source code
@@ -33,6 +35,8 @@ jobs:
3335
ref: 4.x
3436
- name: Set up Python
3537
uses: actions/setup-python@v2
38+
with:
39+
python-version: 3.9 # https://github.com/transifex/transifex-client/pull/330
3640
- name: Install dependencies
3741
run: pip install -U babel jinja2 transifex-client
3842
- name: Extract translations from source code

‎CHANGES‎

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,100 @@ Release 4.3.0 (in development)
44
Dependencies
55
------------
66

7+
* Support Python 3.10
8+
79
Incompatible changes
810
--------------------
911

12+
* #9649: ``searchindex.js``: the embedded data has changed format to allow
13+
objects with the same name in different domains.
14+
* #9672: The rendering of Python domain declarations is implemented
15+
with more docutils nodes to allow better CSS styling.
16+
It may break existing styling.
17+
* #9672: the signature of
18+
:py:meth:`domains.py.PyObject.get_signature_prefix` has changed to
19+
return a list of nodes instead of a plain string.
20+
* #9695: ``domains.js.JSObject.display_prefix`` has been changed into a method
21+
``get_display_prefix`` which now returns a list of nodes
22+
instead of a plain string.
23+
* #9695: The rendering of Javascript domain declarations is implemented
24+
with more docutils nodes to allow better CSS styling.
25+
It may break existing styling.
26+
* #9450: mathjax: Load MathJax via "defer" strategy
27+
28+
1029
Deprecated
1130
----------
1231

32+
* ``sphinx.ext.autodoc.AttributeDocumenter._datadescriptor``
33+
* ``sphinx.writers.html.HTMLTranslator._fieldlist_row_index``
34+
* ``sphinx.writers.html.HTMLTranslator._table_row_index``
35+
* ``sphinx.writers.html5.HTML5Translator._fieldlist_row_index``
36+
* ``sphinx.writers.html5.HTML5Translator._table_row_index``
37+
1338
Features added
1439
--------------
1540

41+
* #9639: autodoc: Support asynchronous generator functions
42+
* #9664: autodoc: ``autodoc-process-bases`` supports to inject reST snippet as a
43+
base class
44+
* #9691: C, added new info-field ``retval``
45+
for :rst:dir:`c:function` and :rst:dir:`c:macro`.
46+
* C++, added new info-field ``retval`` for :rst:dir:`cpp:function`.
47+
* #9672: More CSS classes on Python domain descriptions
48+
* #9695: More CSS classes on Javascript domain descriptions
49+
* #9683: Revert the removal of ``add_stylesheet()`` API. It will be kept until
50+
the Sphinx-6.0 release
51+
* #2068, add :confval:`intersphinx_disabled_reftypes` for disabling
52+
interphinx resolution of cross-references that do not have an explicit
53+
inventory specification. Specific types of cross-references can be disabled,
54+
e.g., ``std:doc`` or all cross-references in a specific domain,
55+
e.g., ``std:*``.
1656
* #9623: Allow to suppress "toctree contains reference to excluded document"
1757
warnings using :confval:`suppress_warnings`
1858

1959
Bugs fixed
2060
----------
2161

62+
* #9630: autodoc: Failed to build cross references if :confval:`primary_domain`
63+
is not 'py'
64+
* #9644: autodoc: Crashed on getting source info from problematic object
65+
* #9655: autodoc: mocked object having doc comment is warned unexpectedly
66+
* #9651: autodoc: return type field is not generated even if
67+
:confval:`autodoc_typehints_description_target` is set to "documented" when
68+
its info-field-list contains ``:returns:`` field
69+
* #9657: autodoc: The base class for a subclass of mocked object is incorrect
70+
* #9607: autodoc: Incorrect base class detection for the subclasses of the
71+
generic class
72+
* #9755: autodoc: memory addresses are shown for aliases
73+
* #9752: autodoc: Failed to detect type annotation for slots attribute
74+
* #9756: autodoc: Crashed if classmethod does not have __func__ attribute
75+
* #9757: autodoc: :confval:`autodoc_inherit_docstrings` does not effect to
76+
overriden classmethods
77+
* #9781: autodoc: :confval:`autodoc_preserve_defaults` does not support
78+
hexadecimal numeric
79+
* #9630: autosummary: Failed to build summary table if :confval:`primary_domain`
80+
is not 'py'
81+
* #9670: html: Fix download file with special characters
82+
* #9710: html: Wrong styles for even/odd rows in nested tables
83+
* #9763: html: parameter name and its type annotation are not separated in HTML
84+
* #9649: HTML search: when objects have the same name but in different domains,
85+
return all of them as result instead of just one.
86+
* #7634: intersphinx: references on the file in sub directory are broken
87+
* #9737: LaTeX: hlist is rendered as a list containing "aggedright" text
88+
* #9678: linkcheck: file extension was shown twice in warnings
89+
* #9697: py domain: An index entry with parens was registered for ``py:method``
90+
directive with ``:property:`` option
91+
* #9775: py domain: Literal typehint was converted to a cross reference when
92+
:confval:`autodoc_typehints='description'`
93+
* #9708: needs_extension failed to check double-digit version correctly
94+
* #9688: Fix :rst:dir:`code`` does not recognize ``:class:`` option
95+
* #9733: Fix for logging handler flushing warnings in the middle of the docs
96+
build
97+
* #9656: Fix warnings without subtype being incorrectly suppressed
98+
* Intersphinx, for unresolved references with an explicit inventory,
99+
e.g., ``proj:myFunc``, leave the inventory prefix in the unresolved text.
100+
22101
Testing
23102
--------
24103

@@ -113,6 +192,7 @@ Bugs fixed
113192
with the HEAD of 3.10
114193
* #9436, #9471: autodoc: crashed if ``autodoc_class_signature = "separated"``
115194
* #9456: html search: html_copy_source can't control the search summaries
195+
* #9500: LaTeX: Failed to build Japanese document on Windows
116196
* #9435: linkcheck: Failed to check anchors in github.com
117197

118198
Release 4.1.1 (released Jul 15, 2021)

‎doc/_static/conf.py.txt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# test documentation build configuration file, created by
22
# sphinx-quickstart on Sun Jun 26 00:00:43 2016.
33
#
4-
# This file is execfile()d with the current directory set to its
5-
# containing dir.
4+
# This file is executed through importlib.import_module with
5+
# the current directory set to its containing dir.
66
#
77
# Note that not all possible configuration values are present in this
88
# autogenerated file.

‎doc/_static/tutorial/lumache-autosummary.png‎

25.9 KB
Loading

‎doc/_static/tutorial/lumache-py-function-full.png‎

70.1 KB
Loading

‎doc/_static/tutorial/lumache-py-function.png‎

40.8 KB
Loading

‎doc/_templates/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ <h2>{%trans%}Contributor Guide{%endtrans%}</h2>
118118
this part of the documentation is for you.{%endtrans%}</p>
119119

120120
<ul>
121-
<li>{%trans path=pathto("internals/contributing")%}<a href="{{ path }}">Sphinx Contributors’s Guide</a></li>{%endtrans%}
121+
<li>{%trans path=pathto("internals/contributing")%}<a href="{{ path }}">Sphinx Contributors’ Guide</a></li>{%endtrans%}
122122
<li>{%trans path=pathto("internals/authors")%}<a href="{{ path }}">Sphinx Authors</a></li>{%endtrans%}
123123
</ul>
124124

‎doc/extdev/builderapi.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ Builder API
1616
.. autoattribute:: name
1717
.. autoattribute:: format
1818
.. autoattribute:: epilog
19+
.. autoattribute:: allow_parallel
1920
.. autoattribute:: supported_image_types
2021
.. autoattribute:: supported_remote_images
2122
.. autoattribute:: supported_data_uri_images

0 commit comments

Comments
 (0)