Skip to content

Commit aa1bc83

Browse files
committed
Merge branch '4.x'
2 parents 759a526 + 017ef61 commit aa1bc83

File tree

419 files changed

+3601
-5733
lines changed

Some content is hidden

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

419 files changed

+3601
-5733
lines changed

.github/workflows/docutils-latest.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ on:
77

88
jobs:
99
test:
10+
if: github.repository_owner == 'sphinx-doc'
1011
runs-on: ubuntu-latest
1112

1213
steps:

.github/workflows/lock.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ permissions:
1010

1111
jobs:
1212
action:
13+
if: github.repository_owner == 'sphinx-doc'
1314
runs-on: ubuntu-latest
1415
steps:
1516
- uses: dessant/lock-threads@v2

.github/workflows/transifex.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ on:
77

88
jobs:
99
push:
10+
if: github.repository_owner == 'sphinx-doc'
1011
runs-on: ubuntu-latest
1112

1213
steps:
@@ -27,6 +28,7 @@ jobs:
2728
TX_TOKEN: ${{ secrets.TX_TOKEN }}
2829

2930
pull:
31+
if: github.repository_owner == 'sphinx-doc'
3032
runs-on: ubuntu-latest
3133

3234
steps:

AUTHORS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,7 @@ Other contributors, listed alphabetically, are:
7474
* Pauli Virtanen -- autodoc improvements, autosummary extension
7575
* Eric N. Vander Weele -- autodoc improvements
7676
* Stefan van der Walt -- autosummary extension
77+
* Hugo van Kemenade -- support FORCE_COLOR and NO_COLOR
7778
* Thomas Waldmann -- apidoc module fixes
7879
* John Waltman -- Texinfo builder
7980
* Barry Warsaw -- setup command improvements

CHANGES

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,12 +91,16 @@ Deprecated
9191
Features added
9292
--------------
9393

94+
* #10260: Enable ``FORCE_COLOR`` and ``NO_COLOR`` for terminal colouring
95+
* #10234: autosummary: Add "autosummary" CSS class to summary tables
9496
* #10125: extlinks: Improve suggestion message for a reference having title
9597
* #9494, #9456: html search: Add a config variable
9698
:confval:`html_show_search_summary` to enable/disable the search summaries
9799
* #9337: HTML theme, add option ``enable_search_shortcuts`` that enables :kbd:'/' as
98100
a Quick search shortcut and :kbd:`Esc` shortcut that
99101
removes search highlighting.
102+
* #10252: C++, support attributes on classes, unions, and enums.
103+
* #10253: :rst:dir:`pep` role now generates URLs based on peps.python.org
100104

101105
Bugs fixed
102106
----------

LICENSE

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
License for Sphinx
22
==================
33

4+
Unless otherwise indicated, all code in the Sphinx project is licenced under the
5+
two clause BSD licence below.
6+
47
Copyright (c) 2007-2022 by the Sphinx team (see AUTHORS file).
58
All rights reserved.
69

doc/man/sphinx-build.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -304,6 +304,22 @@ variables to customize behavior:
304304
Additional options for :program:`sphinx-build`. These options can
305305
also be set via the shortcut variable **O** (capital 'o').
306306

307+
.. describe:: NO_COLOR
308+
309+
When set (regardless of value), :program:`sphinx-build` will not use color
310+
in terminal output. ``NO_COLOR`` takes precedence over ``FORCE_COLOR``. See
311+
`no-color.org <https://no-color.org/>`__ for other libraries supporting this
312+
community standard.
313+
314+
.. versionadded:: 4.5.0
315+
316+
.. describe:: FORCE_COLOR
317+
318+
When set (regardless of value), :program:`sphinx-build` will use color in
319+
terminal output. ``NO_COLOR`` takes precedence over ``FORCE_COLOR``.
320+
321+
.. versionadded:: 4.5.0
322+
307323
.. _when-deprecation-warnings-are-displayed:
308324

309325
Deprecation Warnings

doc/usage/restructuredtext/domains.rst

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -211,6 +211,12 @@ The following directives are provided for module and class contents:
211211
212212
.. versionadded:: 4.0
213213
214+
.. rst::directive:option:: module
215+
:type: text
216+
217+
Describe the location where the object is defined. The default value is
218+
the module specified by :rst:dir:`py:currentmodule`.
219+
214220
.. rst:directive:: .. py:data:: name
215221
216222
Describes global data in a module, including both variables and values used
@@ -237,6 +243,12 @@ The following directives are provided for module and class contents:
237243
238244
.. versionadded:: 4.0
239245
246+
.. rst::directive:option:: module
247+
:type: text
248+
249+
Describe the location where the object is defined. The default value is
250+
the module specified by :rst:dir:`py:currentmodule`.
251+
240252
.. rst:directive:: .. py:exception:: name
241253
242254
Describes an exception class. The signature can, but need not include
@@ -251,6 +263,12 @@ The following directives are provided for module and class contents:
251263
252264
.. versionadded:: 3.1
253265
266+
.. rst::directive:option:: module
267+
:type: text
268+
269+
Describe the location where the object is defined. The default value is
270+
the module specified by :rst:dir:`py:currentmodule`.
271+
254272
.. rst:directive:: .. py:class:: name
255273
.. py:class:: name(parameters)
256274
@@ -291,6 +309,12 @@ The following directives are provided for module and class contents:
291309
292310
.. versionadded:: 3.1
293311
312+
.. rst::directive:option:: module
313+
:type: text
314+
315+
Describe the location where the object is defined. The default value is
316+
the module specified by :rst:dir:`py:currentmodule`.
317+
294318
.. rst:directive:: .. py:attribute:: name
295319
296320
Describes an object data attribute. The description should include
@@ -317,6 +341,12 @@ The following directives are provided for module and class contents:
317341
318342
.. versionadded:: 4.0
319343
344+
.. rst::directive:option:: module
345+
:type: text
346+
347+
Describe the location where the object is defined. The default value is
348+
the module specified by :rst:dir:`py:currentmodule`.
349+
320350
.. rst:directive:: .. py:property:: name
321351
322352
Describes an object property.
@@ -340,6 +370,12 @@ The following directives are provided for module and class contents:
340370
.. rst:directive:option:: type: type of the property
341371
:type: text
342372
373+
.. rst::directive:option:: module
374+
:type: text
375+
376+
Describe the location where the object is defined. The default value is
377+
the module specified by :rst:dir:`py:currentmodule`.
378+
343379
.. rst:directive:: .. py:method:: name(parameters)
344380
345381
Describes an object method. The parameters should not include the ``self``
@@ -385,6 +421,12 @@ The following directives are provided for module and class contents:
385421
386422
.. versionadded:: 3.1
387423
424+
.. rst::directive:option:: module
425+
:type: text
426+
427+
Describe the location where the object is defined. The default value is
428+
the module specified by :rst:dir:`py:currentmodule`.
429+
388430
.. rst:directive:option:: property
389431
:type: no value
390432

package-lock.json

Lines changed: 51 additions & 35 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
},
1313
"devDependencies": {
1414
"jasmine-core": "^3.4.0",
15-
"karma": "^6.3.14",
15+
"karma": "^6.3.16",
1616
"karma-firefox-launcher": "^2.0.0",
1717
"karma-jasmine": "^4.0.0"
1818
}

0 commit comments

Comments
 (0)