Skip to content

Commit 3d8fbd9

Browse files
committed
Merge branch '4.x'
2 parents b8b8041 + ba2439a commit 3d8fbd9

File tree

133 files changed

+2918
-2877
lines changed

Some content is hidden

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

133 files changed

+2918
-2877
lines changed

CHANGES

Lines changed: 41 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Bugs fixed
1919
Testing
2020
--------
2121

22-
Release 4.2.0 (in development)
22+
Release 4.3.0 (in development)
2323
==============================
2424

2525
Dependencies
@@ -34,10 +34,46 @@ Deprecated
3434
Features added
3535
--------------
3636

37+
Bugs fixed
38+
----------
39+
40+
Testing
41+
--------
42+
43+
Release 4.2.1 (in development)
44+
==============================
45+
46+
Dependencies
47+
------------
48+
49+
Incompatible changes
50+
--------------------
51+
52+
Deprecated
53+
----------
54+
55+
Features added
56+
--------------
57+
58+
Bugs fixed
59+
----------
60+
61+
Testing
62+
--------
63+
64+
Release 4.2.0 (released Sep 12, 2021)
65+
=====================================
66+
67+
Features added
68+
--------------
69+
3770
* #9445: autodoc: Support class properties
3871
* #9479: autodoc: Emit a warning if target is a mocked object
72+
* #9560: autodoc: Allow to refer NewType instances with module name in Python
73+
3.10 or above
3974
* #9447: html theme: Expose the version of Sphinx in the form of tuple as a
4075
template variable ``sphinx_version_tuple``
76+
* #9594: manpage: Suppress the title of man page if description is empty
4177
* #9445: py domain: ``:py:property:`` directive supports ``:classmethod:``
4278
option to describe the class property
4379
* #9524: test: SphinxTestApp can take ``builddir`` as an argument
@@ -48,6 +84,10 @@ Bugs fixed
4884

4985
* #9608: apidoc: apidoc does not generate a module definition for implicit
5086
namespace package
87+
* #9504: autodoc: generate incorrect reference to the parent class if the target
88+
class inherites the class having ``_name`` attribute
89+
* #9537, #9589: autodoc: Some objects under ``typing`` module are not displayed
90+
well with the HEAD of 3.10
5191
* #9487: autodoc: typehint for cached_property is not shown
5292
* #9509: autodoc: AttributeError is raised on failed resolving typehints
5393
* #9518: autodoc: autodoc_docstring_signature does not effect to ``__init__()``
@@ -71,37 +111,8 @@ Bugs fixed
71111
function pointers.
72112
* #9564: smartquotes: don't adjust typography for text with
73113
language-highlighted ``:code:`` role.
74-
75-
Testing
76-
--------
77-
78-
Release 4.1.3 (in development)
79-
==============================
80-
81-
Dependencies
82-
------------
83-
84-
Incompatible changes
85-
--------------------
86-
87-
Deprecated
88-
----------
89-
90-
Features added
91-
--------------
92-
93-
Bugs fixed
94-
----------
95-
96-
* #9504: autodoc: generate incorrect reference to the parent class if the target
97-
class inherites the class having ``_name`` attribute
98-
* #9537, #9589: autodoc: Some objects under ``typing`` module are not displayed
99-
well with the HEAD of 3.10
100114
* #9512: sphinx-build: crashed with the HEAD of Python 3.10
101115

102-
Testing
103-
--------
104-
105116
Release 4.1.2 (released Jul 27, 2021)
106117
=====================================
107118

doc/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
epub_theme = 'epub'
3636
epub_basename = 'sphinx'
3737
epub_author = 'Georg Brandl'
38-
epub_publisher = 'https://sphinx-doc.org/'
38+
epub_publisher = 'https://www.sphinx-doc.org/'
3939
epub_uid = 'web-site'
4040
epub_scheme = 'url'
4141
epub_identifier = epub_publisher

doc/make.bat

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ if errorlevel 9009 (
1919
echo.may add the Sphinx directory to PATH.
2020
echo.
2121
echo.If you don't have Sphinx installed, grab it from
22-
echo.https://sphinx-doc.org/
22+
echo.https://www.sphinx-doc.org/
2323
exit /b 1
2424
)
2525

doc/usage/configuration.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2331,6 +2331,8 @@ These options influence manual page output.
23312331

23322332
*description*
23332333
Description of the manual page. This is used in the NAME section.
2334+
Can be an empty string if you do not want to automatically generate
2335+
the NAME section.
23342336

23352337
*authors*
23362338
A list of strings with authors, or a single string. Can be an empty
@@ -2554,7 +2556,7 @@ Options for the linkcheck builder
25542556

25552557
A dictionary that maps baseurls to HTTP request headers.
25562558

2557-
The key is a URL base string like ``"https://sphinx-doc.org/"``. To specify
2559+
The key is a URL base string like ``"https://www.sphinx-doc.org/"``. To specify
25582560
headers for other hosts, ``"*"`` can be used. It matches all hosts only when
25592561
the URL does not match other settings.
25602562

@@ -2565,7 +2567,7 @@ Options for the linkcheck builder
25652567
.. code-block:: python
25662568
25672569
linkcheck_request_headers = {
2568-
"https://sphinx-doc.org/": {
2570+
"https://www.sphinx-doc.org/": {
25692571
"Accept": "text/html",
25702572
"Accept-Encoding": "utf-8",
25712573
},

doc/usage/extensions/graphviz.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -227,13 +227,13 @@ There are also these config values:
227227
attribute must be set, such as ``"_top"`` and ``"_blank"``. For example, the
228228
link in the following graph should work in the svg output: ::
229229

230-
.. graphviz::
230+
.. graphviz::
231231

232-
digraph example {
233-
a [label="sphinx", href="https://sphinx-doc.org", target="_top"];
234-
b [label="other"];
235-
a -> b;
236-
}
232+
digraph example {
233+
a [label="sphinx", href="https://www.sphinx-doc.org/", target="_top"];
234+
b [label="other"];
235+
a -> b;
236+
}
237237

238238
.. versionadded:: 1.0
239239
Previously, output always was PNG.

sphinx/cmd/build.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ def jobs_argument(value: str) -> int:
101101
def get_parser() -> argparse.ArgumentParser:
102102
parser = argparse.ArgumentParser(
103103
usage='%(prog)s [OPTIONS] SOURCEDIR OUTPUTDIR [FILENAMES...]',
104-
epilog=__('For more information, visit <http://sphinx-doc.org/>.'),
104+
epilog=__('For more information, visit <https://www.sphinx-doc.org/>.'),
105105
description=__("""
106106
Generate documentation from source files.
107107

sphinx/cmd/quickstart.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -467,7 +467,7 @@ def get_parser() -> argparse.ArgumentParser:
467467
)
468468
parser = argparse.ArgumentParser(
469469
usage='%(prog)s [OPTIONS] <PROJECT_DIR>',
470-
epilog=__("For more information, visit <http://sphinx-doc.org/>."),
470+
epilog=__("For more information, visit <https://www.sphinx-doc.org/>."),
471471
description=description)
472472

473473
parser.add_argument('-q', '--quiet', action='store_true', dest='quiet',

sphinx/ext/apidoc.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -304,7 +304,7 @@ def get_parser() -> argparse.ArgumentParser:
304304
parser = argparse.ArgumentParser(
305305
usage='%(prog)s [OPTIONS] -o <OUTPUT_PATH> <MODULE_PATH> '
306306
'[EXCLUDE_PATTERN, ...]',
307-
epilog=__('For more information, visit <http://sphinx-doc.org/>.'),
307+
epilog=__('For more information, visit <https://www.sphinx-doc.org/>.'),
308308
description=__("""
309309
Look recursively in <MODULE_PATH> for Python modules and packages and create
310310
one reST file with automodule directives per package in the <OUTPUT_PATH>.

sphinx/ext/autosummary/generate.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -595,7 +595,7 @@ def find_autosummary_in_lines(lines: List[str], module: str = None, filename: st
595595
def get_parser() -> argparse.ArgumentParser:
596596
parser = argparse.ArgumentParser(
597597
usage='%(prog)s [OPTIONS] <SOURCE_FILE>...',
598-
epilog=__('For more information, visit <http://sphinx-doc.org/>.'),
598+
epilog=__('For more information, visit <https://www.sphinx-doc.org/>.'),
599599
description=__("""
600600
Generate ReStructuredText using autosummary directives.
601601

sphinx/ext/napoleon/__init__.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -309,11 +309,11 @@ def setup(app: Sphinx) -> Dict[str, Any]:
309309
See Also
310310
--------
311311
`The Sphinx documentation on Extensions
312-
<http://sphinx-doc.org/extensions.html>`_
312+
<https://www.sphinx-doc.org/extensions.html>`_
313313
314-
`The Extension Tutorial <http://sphinx-doc.org/extdev/tutorial.html>`_
314+
`The Extension Tutorial <https://www.sphinx-doc.org/extdev/tutorial.html>`_
315315
316-
`The Extension API <http://sphinx-doc.org/extdev/appapi.html>`_
316+
`The Extension API <https://www.sphinx-doc.org/extdev/appapi.html>`_
317317
318318
"""
319319
if not isinstance(app, Sphinx):

0 commit comments

Comments
 (0)