Skip to content

Commit e35e7b0

Browse files
authored
Remove unnecessary :func: and :meth: parentheses (#12848)
1 parent bb2c4e9 commit e35e7b0

File tree

7 files changed

+21
-21
lines changed

7 files changed

+21
-21
lines changed

doc/changes/3.5.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ Features added
108108
functions in source code and keep them not evaluated for readability.
109109
* #8619: html: kbd role generates customizable HTML tags for compound keys
110110
* #8634: html: Allow to change the order of JS/CSS via ``priority`` parameter
111-
for :meth:`.Sphinx.add_js_file()` and :meth:`.Sphinx.add_css_file()`
111+
for :meth:`.Sphinx.add_js_file` and :meth:`.Sphinx.add_css_file`
112112
* #6241: html: Allow to add JS/CSS files to the specific page when an extension
113113
calls ``app.add_js_file()`` or ``app.add_css_file()`` on
114114
:event:`html-page-context` event

doc/changes/4.4.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Features added
2727
by an extlink, suggesting a replacement.
2828
* #9961: html: Support nested <kbd> HTML elements in other HTML builders
2929
* #10013: html: Allow to change the loading method of JS via ``loading_method``
30-
parameter for :meth:`.Sphinx.add_js_file()`
30+
parameter for :meth:`.Sphinx.add_js_file`
3131
* #9551: html search: "Hide Search Matches" link removes "highlight" parameter
3232
from URL
3333
* #9815: html theme: Wrap sidebar components in div to allow customizing their

doc/development/html_themes/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ Python :mod:`configparser` module) and has the following structure:
145145
* The **pygments_dark_style** setting gives the name of a Pygments style to use
146146
for highlighting when the CSS media query ``(prefers-color-scheme: dark)``
147147
evaluates to true. It is injected into the page using
148-
:meth:`~sphinx.application.Sphinx.add_css_file()`.
148+
:meth:`~sphinx.application.Sphinx.add_css_file`.
149149

150150
* The **sidebars** setting gives the comma separated list of sidebar templates
151151
for constructing sidebars. This can be overridden by the user in the

doc/extdev/deprecated.rst

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1447,12 +1447,12 @@ The following is a list of deprecated interfaces.
14471447
* - :meth:`!add_stylesheet`
14481448
- 1.8
14491449
- 6.0
1450-
- :meth:`~sphinx.application.Sphinx.add_css_file()`
1450+
- :meth:`~sphinx.application.Sphinx.add_css_file`
14511451

1452-
* - :meth:`!add_javascript()`
1452+
* - :meth:`!add_javascript`
14531453
- 1.8
14541454
- 4.0
1455-
- :meth:`~sphinx.application.Sphinx.add_js_file()`
1455+
- :meth:`~sphinx.application.Sphinx.add_js_file`
14561456

14571457
* - :confval:`autodoc_default_flags`
14581458
- 1.8
@@ -1519,7 +1519,7 @@ The following is a list of deprecated interfaces.
15191519
* - ``sphinx.ext.mathbase.setup_math()``
15201520
- 1.8
15211521
- 3.0
1522-
- :meth:`~sphinx.application.Sphinx.add_html_math_renderer()`
1522+
- :meth:`~sphinx.application.Sphinx.add_html_math_renderer`
15231523

15241524
* - ``sphinx.ext.mathbase.is_in_section_title()``
15251525
- 1.8
@@ -1700,18 +1700,18 @@ The following is a list of deprecated interfaces.
17001700
* - ``Sphinx.override_domain()``
17011701
- 1.8
17021702
- 3.0
1703-
- :meth:`~sphinx.application.Sphinx.add_domain()`
1703+
- :meth:`~sphinx.application.Sphinx.add_domain`
17041704

17051705
* - ``Sphinx.import_object()``
17061706
- 1.8
17071707
- 3.0
17081708
- ``sphinx.util.import_object()``
17091709

17101710
* - ``suffix`` argument of
1711-
:meth:`~sphinx.application.Sphinx.add_source_parser()`
1711+
:meth:`~sphinx.application.Sphinx.add_source_parser`
17121712
- 1.8
17131713
- 3.0
1714-
- :meth:`~sphinx.application.Sphinx.add_source_suffix()`
1714+
- :meth:`~sphinx.application.Sphinx.add_source_suffix`
17151715

17161716

17171717
* - ``BuildEnvironment.load()``
@@ -1792,7 +1792,7 @@ The following is a list of deprecated interfaces.
17921792
* - :confval:`!source_parsers`
17931793
- 1.8
17941794
- 3.0
1795-
- :meth:`~sphinx.application.Sphinx.add_source_parser()`
1795+
- :meth:`~sphinx.application.Sphinx.add_source_parser`
17961796

17971797
* - ``sphinx.util.docutils.directive_helper()``
17981798
- 1.8
@@ -1812,17 +1812,17 @@ The following is a list of deprecated interfaces.
18121812
* - ``sphinx.locale.l_()``
18131813
- 1.8
18141814
- 3.0
1815-
- :func:`sphinx.locale._()`
1815+
- :func:`sphinx.locale._`
18161816

18171817
* - ``sphinx.locale.lazy_gettext()``
18181818
- 1.8
18191819
- 3.0
1820-
- :func:`sphinx.locale._()`
1820+
- :func:`sphinx.locale._`
18211821

18221822
* - ``sphinx.locale.mygettext()``
18231823
- 1.8
18241824
- 3.0
1825-
- :func:`sphinx.locale._()`
1825+
- :func:`sphinx.locale._`
18261826

18271827
* - ``sphinx.util.copy_static_entry()``
18281828
- 1.5
@@ -1857,17 +1857,17 @@ The following is a list of deprecated interfaces.
18571857
* - ``sphinx.ext.autodoc.add_documenter()``
18581858
- 1.7
18591859
- 2.0
1860-
- :meth:`~sphinx.application.Sphinx.add_autodocumenter()`
1860+
- :meth:`~sphinx.application.Sphinx.add_autodocumenter`
18611861

18621862
* - ``sphinx.ext.autodoc.AutoDirective._register``
18631863
- 1.7
18641864
- 2.0
1865-
- :meth:`~sphinx.application.Sphinx.add_autodocumenter()`
1865+
- :meth:`~sphinx.application.Sphinx.add_autodocumenter`
18661866

18671867
* - ``AutoDirective._special_attrgetters``
18681868
- 1.7
18691869
- 2.0
1870-
- :meth:`~sphinx.application.Sphinx.add_autodoc_attrgetter()`
1870+
- :meth:`~sphinx.application.Sphinx.add_autodoc_attrgetter`
18711871

18721872
* - ``Sphinx.warn()``, ``Sphinx.info()``
18731873
- 1.6

doc/extdev/parserapi.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ __ https://docutils.sourceforge.io/docs/dev/hacking.html#parsing-the-document
1212

1313
In Sphinx, the parser modules works as same as docutils. The parsers are
1414
registered to Sphinx by extensions using Application APIs;
15-
:meth:`.Sphinx.add_source_suffix()` and :meth:`.Sphinx.add_source_parser()`.
15+
:meth:`.Sphinx.add_source_suffix` and :meth:`.Sphinx.add_source_parser`.
1616

1717
The *source suffix* is a mapping from file suffix to file type. For example,
1818
``.rst`` file is mapped to ``'restructuredtext'`` type. Sphinx uses the

doc/usage/configuration.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1612,7 +1612,7 @@ and also make use of these options.
16121612
16131613
The special attribute *priority* can be set as an integer
16141614
to load the CSS file at an earlier or later step.
1615-
For more information, refer to :meth:`.Sphinx.add_css_file()`.
1615+
For more information, refer to :meth:`.Sphinx.add_css_file`.
16161616

16171617
.. versionadded:: 1.8
16181618
.. versionchanged:: 3.5
@@ -1641,7 +1641,7 @@ and also make use of these options.
16411641
16421642
As a special attribute, *priority* can be set as an integer
16431643
to load the JavaScript file at an earlier or later step.
1644-
For more information, refer to :meth:`.Sphinx.add_js_file()`.
1644+
For more information, refer to :meth:`.Sphinx.add_js_file`.
16451645

16461646
.. versionadded:: 1.8
16471647
.. versionchanged:: 3.5

doc/usage/restructuredtext/directives.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -840,7 +840,7 @@ __ https://pygments.org/docs/lexers
840840
841841
Strip indentation characters from the code block. When number given,
842842
leading N characters are removed. When no argument given, leading spaces
843-
are removed via :func:`textwrap.dedent()`. For example::
843+
are removed via :func:`textwrap.dedent`. For example::
844844
845845
.. code-block:: ruby
846846
:linenos:

0 commit comments

Comments
 (0)