From 8ca26b9c0c56bb82ec86bd88a23b0df1d907e382 Mon Sep 17 00:00:00 2001 From: sphinx-auto-update Date: Thu, 3 Oct 2024 01:03:47 +0000 Subject: [PATCH] Update translations by GHA https://github.com/sphinx-doc/sphinx-doc-translations/actions/runs/11153903272 --- locale/ar/LC_MESSAGES/changes/1.8.po | 6 +- locale/ar/LC_MESSAGES/changes/index.po | 13 +- locale/ar/LC_MESSAGES/extdev/deprecated.po | 4 +- .../usage/domains/restructuredtext.po | 19 +- .../LC_MESSAGES/usage/extensions/autodoc.po | 674 ++++++++-------- locale/ca_ES/LC_MESSAGES/changes/1.8.po | 6 +- locale/ca_ES/LC_MESSAGES/changes/index.po | 13 +- locale/ca_ES/LC_MESSAGES/extdev/deprecated.po | 4 +- .../usage/domains/restructuredtext.po | 19 +- .../LC_MESSAGES/usage/extensions/autodoc.po | 674 ++++++++-------- locale/de/LC_MESSAGES/changes/1.8.po | 6 +- locale/de/LC_MESSAGES/changes/index.po | 13 +- locale/de/LC_MESSAGES/extdev/deprecated.po | 4 +- .../usage/domains/restructuredtext.po | 19 +- .../LC_MESSAGES/usage/extensions/autodoc.po | 674 ++++++++-------- locale/es/LC_MESSAGES/changes/1.8.po | 6 +- locale/es/LC_MESSAGES/changes/index.po | 13 +- locale/es/LC_MESSAGES/extdev/deprecated.po | 4 +- .../usage/domains/restructuredtext.po | 19 +- .../LC_MESSAGES/usage/extensions/autodoc.po | 674 ++++++++-------- locale/fr/LC_MESSAGES/changes/1.8.po | 6 +- locale/fr/LC_MESSAGES/changes/index.po | 13 +- locale/fr/LC_MESSAGES/extdev/deprecated.po | 6 +- .../usage/domains/restructuredtext.po | 19 +- .../LC_MESSAGES/usage/extensions/autodoc.po | 674 ++++++++-------- locale/it_IT/LC_MESSAGES/changes/1.8.po | 6 +- locale/it_IT/LC_MESSAGES/changes/index.po | 13 +- locale/it_IT/LC_MESSAGES/extdev/deprecated.po | 4 +- .../usage/domains/restructuredtext.po | 19 +- .../LC_MESSAGES/usage/extensions/autodoc.po | 674 ++++++++-------- locale/ja/LC_MESSAGES/changes/1.8.po | 6 +- locale/ja/LC_MESSAGES/changes/index.po | 13 +- locale/ja/LC_MESSAGES/extdev/deprecated.po | 6 +- .../usage/domains/restructuredtext.po | 19 +- .../LC_MESSAGES/usage/extensions/autodoc.po | 695 +++++++++-------- locale/ko/LC_MESSAGES/changes/1.8.po | 6 +- locale/ko/LC_MESSAGES/changes/index.po | 13 +- locale/ko/LC_MESSAGES/extdev/deprecated.po | 4 +- .../usage/domains/restructuredtext.po | 19 +- .../LC_MESSAGES/usage/extensions/autodoc.po | 674 ++++++++-------- locale/pl_PL/LC_MESSAGES/changes/1.8.po | 6 +- locale/pl_PL/LC_MESSAGES/changes/index.po | 13 +- locale/pl_PL/LC_MESSAGES/extdev/deprecated.po | 4 +- .../usage/domains/restructuredtext.po | 19 +- .../LC_MESSAGES/usage/extensions/autodoc.po | 674 ++++++++-------- locale/pot/extdev/deprecated.pot | 4 +- locale/pot/usage/extensions/autodoc.pot | 621 ++++++++------- locale/pt_BR/LC_MESSAGES/changes/1.8.po | 8 +- locale/pt_BR/LC_MESSAGES/changes/index.po | 13 +- locale/pt_BR/LC_MESSAGES/extdev/deprecated.po | 6 +- .../usage/domains/restructuredtext.po | 19 +- .../LC_MESSAGES/usage/extensions/autodoc.po | 738 +++++++++--------- locale/ru/LC_MESSAGES/changes/1.8.po | 6 +- locale/ru/LC_MESSAGES/changes/index.po | 13 +- locale/ru/LC_MESSAGES/extdev/deprecated.po | 4 +- .../usage/domains/restructuredtext.po | 19 +- .../LC_MESSAGES/usage/extensions/autodoc.po | 674 ++++++++-------- locale/sr/LC_MESSAGES/changes/1.8.po | 6 +- locale/sr/LC_MESSAGES/changes/index.po | 13 +- locale/sr/LC_MESSAGES/extdev/deprecated.po | 4 +- .../usage/domains/restructuredtext.po | 19 +- .../LC_MESSAGES/usage/extensions/autodoc.po | 674 ++++++++-------- locale/zh_CN/LC_MESSAGES/changes/1.8.po | 10 +- locale/zh_CN/LC_MESSAGES/changes/index.po | 13 +- locale/zh_CN/LC_MESSAGES/extdev/deprecated.po | 6 +- .../usage/domains/restructuredtext.po | 19 +- .../LC_MESSAGES/usage/extensions/autodoc.po | 703 +++++++++-------- sphinx | 2 +- 68 files changed, 5537 insertions(+), 4526 deletions(-) diff --git a/locale/ar/LC_MESSAGES/changes/1.8.po b/locale/ar/LC_MESSAGES/changes/1.8.po index b2dbb34596..54a1c5d608 100644 --- a/locale/ar/LC_MESSAGES/changes/1.8.po +++ b/locale/ar/LC_MESSAGES/changes/1.8.po @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-09-29 00:54+0000\n" +"POT-Creation-Date: 2024-10-03 00:49+0000\n" "PO-Revision-Date: 2024-07-31 00:36+0000\n" "Language-Team: Arabic (https://app.transifex.com/sphinx-doc/teams/15434/ar/)\n" "MIME-Version: 1.0\n" @@ -396,7 +396,7 @@ msgstr "" #: ../../sphinx/doc/changes/1.8.rst:150 msgid "" "#5421: autodoc emits deprecation warning for " -":confval:`autodoc_default_flags`" +":confval:`!autodoc_default_flags`" msgstr "" #: ../../sphinx/doc/changes/1.8.rst:151 @@ -664,7 +664,7 @@ msgid ":confval:`!source_parsers` is deprecated" msgstr "" #: ../../sphinx/doc/changes/1.8.rst:254 -msgid ":confval:`autodoc_default_flags` is deprecated" +msgid ":confval:`!autodoc_default_flags` is deprecated" msgstr "" #: ../../sphinx/doc/changes/1.8.rst:255 diff --git a/locale/ar/LC_MESSAGES/changes/index.po b/locale/ar/LC_MESSAGES/changes/index.po index 0c13155ed7..8648c41d54 100644 --- a/locale/ar/LC_MESSAGES/changes/index.po +++ b/locale/ar/LC_MESSAGES/changes/index.po @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-09-28 00:48+0000\n" +"POT-Creation-Date: 2024-10-03 00:49+0000\n" "PO-Revision-Date: 2024-07-31 00:36+0000\n" "Language-Team: Arabic (https://app.transifex.com/sphinx-doc/teams/15434/ar/)\n" "MIME-Version: 1.0\n" @@ -234,11 +234,18 @@ msgid "" ":rst:dir:`py:module` directives. Patch by Stephen Finucane." msgstr "" -#: ../../sphinx/CHANGES.rst:112 +#: ../../sphinx/CHANGES.rst:110 +msgid "" +"#12916: Restore support for custom templates named with the legacy ``_t`` " +"suffix during ``apidoc`` RST rendering (regression in 7.4.0). Patch by James" +" Addison." +msgstr "" + +#: ../../sphinx/CHANGES.rst:115 msgid "Testing" msgstr "" -#: ../../sphinx/CHANGES.rst:114 +#: ../../sphinx/CHANGES.rst:117 msgid "" "#12141: Migrate from the deprecated ``karma`` JavaScript test framework to " "the actively-maintained ``jasmine`` framework. Test coverage is unaffected." diff --git a/locale/ar/LC_MESSAGES/extdev/deprecated.po b/locale/ar/LC_MESSAGES/extdev/deprecated.po index 6a5f0a2312..cccbfa2548 100644 --- a/locale/ar/LC_MESSAGES/extdev/deprecated.po +++ b/locale/ar/LC_MESSAGES/extdev/deprecated.po @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-09-02 00:47+0000\n" +"POT-Creation-Date: 2024-10-03 00:50+0000\n" "PO-Revision-Date: 2019-03-09 18:04+0000\n" "Language-Team: Arabic (https://app.transifex.com/sphinx-doc/teams/15434/ar/)\n" "MIME-Version: 1.0\n" @@ -2848,7 +2848,7 @@ msgid ":meth:`~sphinx.application.Sphinx.add_js_file`" msgstr "" #: ../../sphinx/doc/extdev/deprecated.rst:1457 -msgid ":confval:`autodoc_default_flags`" +msgid ":confval:`!autodoc_default_flags`" msgstr "" #: ../../sphinx/doc/extdev/deprecated.rst:1460 diff --git a/locale/ar/LC_MESSAGES/usage/domains/restructuredtext.po b/locale/ar/LC_MESSAGES/usage/domains/restructuredtext.po index ad0c724e58..ecc82c55ba 100644 --- a/locale/ar/LC_MESSAGES/usage/domains/restructuredtext.po +++ b/locale/ar/LC_MESSAGES/usage/domains/restructuredtext.po @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-09-15 00:53+0000\n" +"POT-Creation-Date: 2024-10-03 00:49+0000\n" "PO-Revision-Date: 2023-10-03 00:37+0000\n" "Language-Team: Arabic (https://app.transifex.com/sphinx-doc/teams/15434/ar/)\n" "MIME-Version: 1.0\n" @@ -75,3 +75,20 @@ msgstr "" #: ../../sphinx/doc/usage/domains/restructuredtext.rst:97 msgid "These roles are provided to refer to the described objects:" msgstr "" + +#: ../../sphinx/doc/usage/domains/restructuredtext.rst:101 +msgid "Reference directives and directive options. Examples:" +msgstr "" + +#: ../../sphinx/doc/usage/domains/restructuredtext.rst:103 +msgid "Use ``:rst:dir:`my-directive``` to reference a directive." +msgstr "" + +#: ../../sphinx/doc/usage/domains/restructuredtext.rst:104 +msgid "" +"Use ``:rst:dir:`my-directive:my-option``` to reference a directive option." +msgstr "" + +#: ../../sphinx/doc/usage/domains/restructuredtext.rst:109 +msgid "Reference a role. Example: ``:rst:role:`my-role```." +msgstr "" diff --git a/locale/ar/LC_MESSAGES/usage/extensions/autodoc.po b/locale/ar/LC_MESSAGES/usage/extensions/autodoc.po index fe7aff80bd..8b70ddd355 100644 --- a/locale/ar/LC_MESSAGES/usage/extensions/autodoc.po +++ b/locale/ar/LC_MESSAGES/usage/extensions/autodoc.po @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-10-02 00:49+0000\n" +"POT-Creation-Date: 2024-10-03 00:50+0000\n" "PO-Revision-Date: 2018-06-26 15:58+0000\n" "Language-Team: Arabic (https://app.transifex.com/sphinx-doc/teams/15434/ar/)\n" "MIME-Version: 1.0\n" @@ -21,26 +21,26 @@ msgstr "" msgid ":mod:`sphinx.ext.autodoc` -- Include documentation from docstrings" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:12 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:15 msgid "" "This extension can import the modules you are documenting, and pull in " "documentation from docstrings in a semi-automatic way." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:17 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:20 msgid "" ":mod:`~sphinx.ext.autodoc` **imports** the modules to be documented. If any " "modules have side effects on import, these will be executed by ``autodoc`` " "when :program:`sphinx-build` is run." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:21 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:24 msgid "" "If you document scripts (as opposed to library modules), make sure that the " "main routine is protected by an ``if __name__ == '__main__'`` condition." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:25 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:28 msgid "" "For this to work, the docstrings must of course be written in correct " "reStructuredText. You can then use all of the usual Sphinx markup in the " @@ -50,7 +50,7 @@ msgid "" "auto-generated-looking pure API documentation." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:33 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:36 msgid "" "If you prefer `NumPy`_ or `Google`_ style docstrings over reStructuredText, " "you can also enable the :mod:`napoleon ` extension. " @@ -58,25 +58,25 @@ msgid "" "reStructuredText before ``autodoc`` processes them." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:43 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:46 msgid "Getting started" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:47 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:50 msgid "Setup" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:49 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:52 msgid "" "Activate the plugin by adding ``'sphinx.ext.autodoc'`` to the " ":confval:`extensions` list in :file:`conf.py`:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:61 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:64 msgid "Ensuring the code can be imported" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:63 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:66 msgid "" ":mod:`~sphinx.ext.autodoc` analyses the code and docstrings by introspection" " after **importing the modules**. For importing to work, you have to make " @@ -86,11 +86,11 @@ msgid "" "fail)." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:70 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:73 msgid "There are two ways to ensure this:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:72 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:75 msgid "" "Use an environment that contains your package and Sphinx. This can e.g. be " "your local development environment (with an editable install), or an " @@ -99,14 +99,14 @@ msgid "" "that all dependencies are available." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:78 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:81 msgid "" "It is alternatively possible to patch the Sphinx run so that it can operate " "directly on the sources; e.g. if you want to be able to do a Sphinx build " "from a source checkout." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:82 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:85 msgid "" "Patch :data:`sys.path` in :file:`conf.py` to include your source path. For " "example if you have a repository structure with :file:`doc/conf.py` and your" @@ -114,17 +114,17 @@ msgid "" "your :file:`conf.py`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:94 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:97 msgid "" "To cope with missing dependencies, specify the missing modules in the " ":confval:`autodoc_mock_imports` setting." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:99 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:102 msgid "Usage" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:101 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:104 msgid "" "You can now use the :ref:`autodoc-directives` to add formatted documentation" " for Python code elements like functions, classes, modules, etc. For " @@ -132,48 +132,48 @@ msgid "" "docstring from the source file, you'd write:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:110 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:113 msgid "" "You can also document whole classes or even modules automatically, using " "member options for the auto directives, like:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:119 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:122 msgid "" "As a hint to autodoc extension, you can put a ``::`` separator between the " "module name and the object name to let autodoc know the correct module, if " "it is ambiguous:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:129 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:132 msgid "Marking objects as public or private" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:131 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:134 msgid "" "autodoc considers a member private if its docstring contains ``:meta " "private:`` in its :ref:`info-field-lists`. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:145 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:148 msgid "" "autodoc considers a member public if its docstring contains ``:meta " "public:`` in its :ref:`info-field-lists`, even if it starts with an " "underscore. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:160 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:163 msgid "" "autodoc considers a variable member does not have any default value if its " "docstring contains ``:meta hide-value:`` in its :ref:`info-field-lists`. " "Example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:174 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:177 msgid "Doc comments and docstrings" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:176 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:179 msgid "" "Python has no built-in support for docstrings for module data members or " "class attributes. To allow documenting these, ``autodoc`` recognises a " @@ -181,7 +181,7 @@ msgid "" " 'documentation comment'." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:181 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:184 msgid "" "These comments start with a colon and an optional space character, ``'#:'`` " "or ``'#: '``. To be recognised, the comments must appear either on the same " @@ -190,28 +190,28 @@ msgid "" "definition." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:188 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:191 msgid "" "For example, all three of the following variables have valid doc-comments:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:202 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:205 msgid "" "Alternatively, ``autodoc`` can recognise a docstring on the line immediately" " following the definition." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:205 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:208 msgid "" "In the the following class definition, all attributes have documentation " "recognised by ``autodoc``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:233 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:236 msgid "Directives" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:235 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:238 msgid "" ":mod:`autodoc` provides several directives that are versions of the usual " ":rst:dir:`py:module`, :rst:dir:`py:class` and so forth. On parsing time, " @@ -220,24 +220,24 @@ msgid "" ":rst:dir:`py:module`, :rst:dir:`py:class` etc. directive." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:244 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:247 msgid "" "Just as :rst:dir:`py:class` respects the current :rst:dir:`py:module`, " ":rst:dir:`autoclass` will also do so. Likewise, :rst:dir:`automethod` will " "respect the current :rst:dir:`py:class`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:250 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:253 msgid "Default directive options" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:252 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:255 msgid "" "To make any of the options described below the default, use the " ":confval:`autodoc_default_options` dictionary in :file:`conf.py`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:255 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:258 msgid "" "If using defaults for the ``:members:``, ``:exclude-members:``, ``:private-" "members:``, or ``:special-members:`` options, setting the option on a " @@ -246,111 +246,111 @@ msgid "" "(``+``), as follows:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:269 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:272 msgid "" "If using :confval:`autodoc_default_options`, the defaults can be disabled " "per-directive with the negated form, :samp:`:no-{option}:` as an option of " "the directive For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:281 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:284 msgid "Automatically document modules" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:285 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:288 msgid "" "Document a module. By default, the directive only inserts the docstring of " "the module itself:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:292 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:526 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:792 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:866 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:295 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:531 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:797 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:871 msgid "will produce source like this:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:300 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:534 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:303 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:539 msgid "" "The directive can also contain content of its own, which will be inserted " "into the resulting non-auto directive source after the docstring (but before" " any automatic member documentation)." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:304 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:538 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:878 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:307 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:543 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:883 msgid "" "Therefore, you can also mix automatic and non-automatic member " "documentation, as follows:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:317 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:567 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:844 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:894 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:320 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:572 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:849 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:899 msgid "Options" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:321 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:324 msgid "" "Do not generate an index entry for the documented module or any auto-" "documented members." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:329 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:332 msgid "" "Indicate platforms on which the module is available. This is identical to " ":rst:dir:`py:module`'s ``:platform:`` option." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:335 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:338 msgid "" "A sentence describing the module's purpose. This is identical to " ":rst:dir:`py:module`'s ``:synopsis:`` option." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:343 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:346 msgid "" "Mark a module as deprecated. This is identical to :rst:dir:`py:module`'s " "``:deprecated:`` option." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:351 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:354 msgid "Do not use ``__all__`` when analysing the module to document." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:356 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:600 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:359 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:605 msgid "Options for selecting members to document" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:360 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:363 msgid "Generate automatic documentation for all members of the target module:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:367 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:370 msgid "" "By default, ``autodoc`` only includes public members with a docstring or " ":ref:`doc-comment ` (``#:``). If ``__all__`` exists, it will be" -" used to define which members are public, unless the ``:ignore-module-all:``" -" option is set." +" used to define which members are public, unless the :rst:dir:`:ignore-" +"module-all: ` option is set." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:372 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:615 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:376 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:620 msgid "" "To only document certain members, an explicit comma-separated list may be " "used as the argument to ``:members:``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:383 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:626 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:387 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:631 msgid "Exclude the given names from the members to document. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:397 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:401 msgid "" "To prevent documentation of imported classes or functions, in an " ":rst:dir:`!automodule` directive with the ``members`` option set, only " @@ -358,198 +358,197 @@ msgid "" "name given to ``automodule`` will be documented." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:402 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:406 msgid "" "Set the ``imported-members`` option if you want to prevent this behavior and" " document all available members." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:405 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:409 msgid "" "Note that attributes from imported modules will not be documented, because " "attribute documentation is discovered by parsing the source file of the " "current module." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:414 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:418 msgid "" "Generate automatic documentation for members of the target module that don't" " have a docstring or doc-comment. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:427 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:431 msgid "" "Generate automatic documentation for private members of the target module. " "This includes names with a leading underscore (e.g. ``_private``) and those " "members explicitly marked as private with ``:meta private:``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:437 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:703 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:441 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:708 msgid "" "To only document certain private members, an explicit comma-separated list " "may be used as the argument to ``:private-members:``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:447 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:475 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:741 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:451 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:479 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:746 msgid "The option can now take a comma-separated list of arguments." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:453 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:457 msgid "" "Generate automatic documentation for special members of the target module, " -"also known as :ref:`\"dunder\" names `. This includes " -"all names enclosed with a double-underscore, e.g. ``__special__``:" +"also known as :ref:`'dunder' names `. This includes all" +" names enclosed with a double-underscore, e.g. ``__special__``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:464 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:730 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:468 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:735 msgid "" "To only document certain special members, an explicit comma-separated list " "may be used as the argument to ``:special-members:``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:479 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:745 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:483 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:750 msgid "Options for documented members" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:483 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:749 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:487 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:754 msgid "" "Choose the ordering of automatically documented members (default: " "``alphabetical``). This overrides the :confval:`autodoc_member_order` " "setting." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:487 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:491 msgid "``alphabetical``: Use simple alphabetical order." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:489 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:493 msgid "" "``groupwise``: Group by object type (class, function, etc), use alphabetical" " order within groups." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:492 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:496 msgid "" "``bysource``: Use the order of objects in the module's source. The " "``__all__`` variable can be used to override this order." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:496 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:762 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:980 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:500 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:767 msgid "" "Note that for source order, the module must be a Python module with the " "source code available." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:500 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:766 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:504 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:771 msgid "Support the ``'bysource'`` option." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:506 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:510 msgid "" -"Enable the ``:show-inheritance:`` option for all members of the module, if " -"``:members:`` is enabled." +"Enable the :rst:dir:`:show-inheritance: ` option" +" for all members of the module, if ``:members:`` is enabled." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:513 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:518 msgid "Automatically document classes or exceptions" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:518 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:523 msgid "" -"Document a class. For exception classes, prefer ``autoexception``. By " +"Document a class. For exception classes, prefer ``.. autoexception::``. By " "default, the directive only inserts the docstring of the class itself:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:551 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:828 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:556 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:833 msgid "Advanced usage" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:552 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:829 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:557 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:834 msgid "" "It is possible to override the signature for explicitly documented callable " "objects (functions, methods, classes) with the regular syntax that will " "override the signature gained from introspection:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:562 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:839 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:567 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:844 msgid "" "This is useful if the signature from the method is hidden by a decorator." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:571 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:898 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:576 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:903 msgid "" "Do not generate an index entry for the documented class or any auto-" "documented members." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:579 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:584 msgid "" "Select which docstring will be used for the main body of the directive. This" " overrides the global value of :confval:`autoclass_content`. The possible " "values are:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:583 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:588 msgid "" "``class``: Only use the class's docstring. The :meth:`!__init__` method can " "be separately documented using the ``:members:`` option or " ":rst:dir:`automethod`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:587 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:592 msgid "``init``: Only use the docstring of the :meth:`!__init__` method." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:589 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:594 msgid "" -"``both`` Use both, appending the docstring of the :meth:`!__init__` method " +"``both``: Use both, appending the docstring of the :meth:`!__init__` method " "to the class's docstring." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:593 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:598 msgid "" "If the :meth:`!__init__` method doesn't exist or has a blank docstring, " "``autodoc`` will attempt to use the :meth:`!__new__` method's docstring, if " "it exists and is not blank." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:604 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:609 msgid "Generate automatic documentation for all members of the target class:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:611 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:616 msgid "" "By default, ``autodoc`` only includes public members with a docstring or " ":ref:`doc-comment ` (``#:``) that are attributes of the target " "class (i.e. not inherited)." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:640 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:645 msgid "" "To generate automatic documentation for members inherited from base classes," " use the ``:inherited-members:`` option:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:649 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:654 msgid "" "This can be combined with the ``:undoc-members:`` option to generate " "automatic documentation for *all* available members of the class." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:652 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:657 msgid "" "The members of classes listed in the argument to ``:inherited-members:`` are" " excluded from the automatic documentation. This defaults to " @@ -558,105 +557,105 @@ msgid "" "as the argument." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:658 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:663 msgid "" "For example; If your class ``MyList`` is derived from ``list`` class and you" " don't want to document ``list.__len__()``, you should specify a option " "``:inherited-members: list`` to avoid special members of list class." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:664 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:669 msgid "" "Should any of the inherited members use a format other than reStructuredText" " for their docstrings, there may be markup warnings or errors." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:670 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:675 msgid "" "``:inherited-members:`` now takes the name of a base class to exclude as an " "argument." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:674 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:679 msgid "A comma separated list of base class names can be used." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:680 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:685 msgid "" "Generate automatic documentation for members of the target class that don't " "have a docstring or doc-comment. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:693 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:698 msgid "" "Generate automatic documentation for private members of the target class. " "This includes names with a leading underscore (e.g. ``_private``) and those " "members explicitly marked as private with ``:meta private:``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:713 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:718 msgid "The option can now take arguments." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:719 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:724 msgid "" "Generate automatic documentation for special members of the target class, " -"also known as :ref:`\"dunder\" names `. This includes " -"all names enclosed with a double-underscore, e.g. ``__special__``:" +"also known as :ref:`'dunder' names `. This includes all" +" names enclosed with a double-underscore, e.g. ``__special__``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:753 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:758 msgid "``'alphabetical'``: Use simple alphabetical order." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:755 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:760 msgid "" "``'groupwise'``: Group by object type (class, function, etc), use " "alphabetical order within groups." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:758 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:763 msgid "" "``'bysource'``: Use the order of objects in the module's source. The " "``__all__`` variable can be used to override this order." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:772 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:777 msgid "Insert the class's base classes after the class signature." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:778 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:783 msgid "Automatically document function-like objects" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:785 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:790 msgid "" "Document a function, method, property, or decorator. By default, the " "directive only inserts the docstring of the function itself:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:800 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:874 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:805 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:879 msgid "" "The directive can also contain content of its own, which will be inserted " "into the resulting non-auto directive source after the docstring." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:804 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:809 msgid "" "Therefore, you can also mix automatic and non-automatic documentation, as " "follows:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:813 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:818 msgid ":rst:dir:`autodecorator`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:815 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:820 msgid ":rst:dir:`autoproperty`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:820 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:825 msgid "" "If you document decorated functions or methods, keep in mind that " "``autodoc`` retrieves its docstrings by importing the module and inspecting " @@ -665,30 +664,30 @@ msgid "" "the original ``__doc__`` to the new function." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:848 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:853 msgid "Do not generate an index entry for the documented function." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:854 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:859 msgid "Automatically document attributes or data" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:859 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:864 msgid "" "Document a module level variable or constant ('data') or class attribute. By" " default, the directive only inserts the docstring of the variable itself:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:887 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:892 msgid "" ":rst:dir:`autodata` and :rst:dir:`autoattribute` can now extract docstrings." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:890 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:895 msgid "Doc-comments are now allowed on the same line of an assignment." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:908 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:913 msgid "" "By default, ``autodoc`` attempts to obtain the type annotation and value of " "the variable by introspection, displaying it after the variable's name. To " @@ -696,165 +695,225 @@ msgid "" "argument to ``annotation``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:914 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:919 msgid "" "For example, if the runtime value of ``FILE_MODE`` is ``0o755``, the " "displayed value will be ``493`` (as ``oct(493) == '0o755'``). This can be " "fixed by setting ``:annotation: = 0o755``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:918 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:923 msgid "" -"If ``annotation`` is used without arguments, no value or type hint will be " -"shown for the variable." +"If ``:annotation:`` is used without arguments, no value or type hint will be" +" shown for the variable." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:925 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:930 msgid "" -"To display the type hint of the variable without a value, use the ``no-" -"value`` option. If both the ``annotation`` and ``no-value`` options are " -"used, ``no-value`` has no effect." +"To display the type hint of the variable without a value, use the ``:no-" +"value:`` option. If both the ``:annotation:`` and ``:no-value:`` options are" +" used, ``:no-value:`` has no effect." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:932 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:937 msgid "Configuration" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:934 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:939 msgid "There are also config values that you can set:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:938 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:0 +msgid "Type" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:0 +msgid "Default" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:945 msgid "" "This value selects what content will be inserted into the main body of an " ":rst:dir:`autoclass` directive. The possible values are:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:941 -msgid "``\"class\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:948 +msgid "``'class'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:942 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:949 msgid "" -"Only the class' docstring is inserted. This is the default. You can still " -"document ``__init__`` as a separate method using :rst:dir:`automethod` or " -"the ``members`` option to :rst:dir:`autoclass`." +"Only the class' docstring is inserted. You can still document ``__init__`` " +"as a separate method using :rst:dir:`automethod` or the ``members`` option " +"to :rst:dir:`autoclass`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:945 -msgid "``\"both\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:952 +msgid "``'both'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:946 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:953 msgid "" "Both the class' and the ``__init__`` method's docstring are concatenated and" " inserted." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:948 -msgid "``\"init\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:955 +msgid "``'init'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:949 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:956 msgid "Only the ``__init__`` method's docstring is inserted." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:953 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:960 msgid "" "If the class has no ``__init__`` method or if the ``__init__`` method's " "docstring is empty, but the class has a ``__new__`` method's docstring, it " "is used instead." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:961 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:970 msgid "" "This value selects how the signature will be displayed for the class defined" " by :rst:dir:`autoclass` directive. The possible values are:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:964 -msgid "``\"mixed\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:973 +msgid "``'mixed'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:965 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:974 msgid "Display the signature with the class name." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:966 -msgid "``\"separated\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:975 +msgid "``'separated'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:967 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:976 msgid "Display the signature as a method." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:969 -msgid "The default is ``\"mixed\"``." -msgstr "" - -#: ../../sphinx/doc/usage/extensions/autodoc.rst:975 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:984 msgid "" -"This value selects if automatically documented members are sorted " -"alphabetical (value ``'alphabetical'``), by member type (value " -"``'groupwise'``) or by source order (value ``'bysource'``). The default is " -"alphabetical." +"Define the order in which :rst:dir:`automodule` and :rst:dir:`autoclass` " +"members are listed. Supported values are:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:984 -msgid "Support for ``'bysource'``." +#: ../../sphinx/doc/usage/extensions/autodoc.rst:987 +msgid "``'alphabetical'``: Use alphabetical order." msgstr "" #: ../../sphinx/doc/usage/extensions/autodoc.rst:989 +msgid "``'groupwise'``: order by member type. The order is:" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:991 +msgid "for modules, exceptions, classes, functions, data" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:992 +msgid "for classes: methods, then properties and attributes" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:994 +msgid "Members are ordered alphabetically within groups." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:996 msgid "" -"This value is a list of autodoc directive flags that should be automatically" -" applied to all autodoc directives. The supported flags are ``'members'``, " -"``'undoc-members'``, ``'private-members'``, ``'special-members'``, " -"``'inherited-members'``, ``'show-inheritance'``, ``'ignore-module-all'`` and" -" ``'exclude-members'``." +"``'bysource'``: Use the order in which the members appear in the source " +"code. This requires that the module must be a Python module with the source " +"code available." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:999 -msgid "Integrated into :confval:`autodoc_default_options`." +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1002 +msgid "Support for ``'bysource'``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1003 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1009 msgid "" "The default options for autodoc directives. They are applied to all autodoc" " directives automatically. It must be a dictionary which maps option names " "to the values. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1017 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1023 msgid "" "Setting ``None`` or ``True`` to the value is equivalent to giving only the " "option name to the directives." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1020 -msgid "" -"The supported options are ``'members'``, ``'member-order'``, ``'undoc-" -"members'``, ``'private-members'``, ``'special-members'``, ``'inherited-" -"members'``, ``'show-inheritance'``, ``'ignore-module-all'``, ``'imported-" -"members'``, ``'exclude-members'``, ``'class-doc-from'`` and ``'no-value'``." +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1026 +msgid "The supported options are:" msgstr "" #: ../../sphinx/doc/usage/extensions/autodoc.rst:1028 -msgid "Accepts ``True`` as a value." +msgid "``'members'``: See :rst:dir:`automodule:members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1029 +msgid "``'undoc-members'`` See :rst:dir:`automodule:undoc-members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1030 +msgid "``'private-members'``: See :rst:dir:`automodule:private-members`." msgstr "" #: ../../sphinx/doc/usage/extensions/autodoc.rst:1031 -msgid "Added ``'imported-members'``." +msgid "``'special-members'``: See :rst:dir:`automodule:special-members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1032 +msgid "``'inherited-members'``: See :rst:dir:`autoclass:inherited-members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1033 +msgid "``'imported-members'``: See :rst:dir:`automodule:imported-members`." msgstr "" #: ../../sphinx/doc/usage/extensions/autodoc.rst:1034 -msgid "Added ``'class-doc-from'``." +msgid "``'exclude-members'``: See :rst:dir:`automodule:exclude-members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1035 +msgid "``'ignore-module-all'``: See :rst:dir:`automodule:ignore-module-all`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1036 +msgid "``'member-order'``: See :rst:dir:`automodule:member-order`." msgstr "" #: ../../sphinx/doc/usage/extensions/autodoc.rst:1037 +msgid "``'show-inheritance'``: See :rst:dir:`autoclass:show-inheritance`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1038 +msgid "``'class-doc-from'``: See :rst:dir:`autoclass:class-doc-from`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1039 +msgid "``'no-value'``: See :rst:dir:`autodata:no-value`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1043 +msgid "Accepts ``True`` as a value." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1046 +msgid "Added ``'imported-members'``." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1049 +msgid "Added ``'class-doc-from'``." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1052 msgid "Added ``'no-value'``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1042 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1059 msgid "" "Functions imported from C modules cannot be introspected, and therefore the " "signature for such functions cannot be automatically determined. However, " @@ -862,7 +921,7 @@ msgid "" "the function's docstring." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1047 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1064 msgid "" "If this boolean value is set to ``True`` (which is the default), autodoc " "will look at the first line of the docstring for functions and methods, and " @@ -870,22 +929,22 @@ msgid "" "from the docstring content." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1052 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1069 msgid "" "autodoc will continue to look for multiple signature lines, stopping at the " "first line that does not look like a signature. This is useful for declaring" " overloaded function signatures." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1059 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1076 msgid "Support overloaded signatures" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1063 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1080 msgid "Overloaded signatures do not need to be separated by a backslash" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1067 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1086 msgid "" "This value contains a list of modules to be mocked up. This is useful when " "some external dependencies are not met at build time and break the building " @@ -893,198 +952,194 @@ msgid "" "themselves and omit the sub-modules:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1076 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1095 msgid "Will mock all imports under the ``django`` package." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1080 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1099 msgid "" "This config value only requires to declare the top-level modules that should" " be mocked." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1086 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1107 msgid "" "This value controls how to represent typehints. The setting takes the " "following values:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1089 -msgid "``'signature'`` -- Show typehints in the signature (default)" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1110 +msgid "``'signature'`` -- Show typehints in the signature" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1090 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1111 msgid "" "``'description'`` -- Show typehints as content of the function or method The" " typehints of overloaded functions or methods will still be represented in " "the signature." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1093 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1114 msgid "``'none'`` -- Do not show typehints" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1094 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1115 msgid "" "``'both'`` -- Show typehints in the signature and as content of the function" " or method" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1097 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1118 msgid "" "Overloaded functions or methods will not have typehints included in the " "description because it is impossible to accurately represent all possible " "overloads as a list of parameters." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1104 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1125 msgid "New option ``'description'`` is added." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1108 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1129 msgid "New option ``'both'`` is added." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1112 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1135 msgid "" "This value controls whether the types of undocumented parameters and return " -"values are documented when ``autodoc_typehints`` is set to ``description``." +"values are documented when :confval:`autodoc_typehints` is set to " +"``'description'``. Supported values:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1115 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1140 msgid "" -"The default value is ``\"all\"``, meaning that types are documented for all " -"parameters and return values, whether they are documented or not." +"``'all'``: Types are documented for all parameters and return values, " +"whether they are documented or not." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1118 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1143 msgid "" -"When set to ``\"documented\"``, types will only be documented for a " -"parameter or a return value that is already documented by the docstring." +"``'documented'``: Types will only be documented for a parameter or a return " +"value that is already documented by the docstring." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1121 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1146 msgid "" -"With ``\"documented_params\"``, parameter types will only be annotated if " -"the parameter is documented in the docstring. The return type is always " +"``'documented_params'``: Parameter types will only be annotated if the " +"parameter is documented in the docstring. The return type is always " "annotated (except if it is ``None``)." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1129 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1155 msgid "New option ``'documented_params'`` is added." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1133 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1161 msgid "" "A dictionary for users defined `type aliases`__ that maps a type name to the" " full-qualified object name. It is used to keep type aliases not evaluated " -"in the document. Defaults to empty (``{}``)." +"in the document." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1137 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1165 msgid "" "The type aliases are only available if your program enables :pep:`Postponed " "Evaluation of Annotations (PEP 563) <563>` feature via ``from __future__ " "import annotations``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1141 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1169 msgid "For example, there is code using a type alias:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1152 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1180 msgid "" "If ``autodoc_type_aliases`` is not set, autodoc will generate internal mark-" "up from this code as following:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1161 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1189 msgid "" "If you set ``autodoc_type_aliases`` as ``{'AliasType': " "'your.module.AliasType'}``, it generates the following document internally:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1176 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1206 msgid "" "This value controls the format of typehints. The setting takes the " "following values:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1179 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1209 msgid "" "``'fully-qualified'`` -- Show the module name and its name of typehints" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1180 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1210 msgid "" "``'short'`` -- Suppress the leading module names of the typehints (e.g. " -"``io.StringIO`` -> ``StringIO``) (default)" +"``io.StringIO`` -> ``StringIO``)" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1187 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1217 msgid "The default setting was changed to ``'short'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1191 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1223 msgid "" "If True, the default argument values of functions will be not evaluated on " "generating document. It preserves them as is in the source code." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1196 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1228 msgid "" "Added as an experimental feature. This will be integrated into autodoc core" " in the future." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1201 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1235 msgid "" "This value controls the behavior of :option:`sphinx-build --fail-on-warning`" " during importing modules. If ``False`` is given, autodoc forcedly " -"suppresses the error if the imported module emits warnings. By default, " -"``True``." +"suppresses the error if the imported module emits warnings." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1206 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1240 msgid "" "This option now has no effect as :option:`!--fail-on-warning` no longer " "exits early." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1212 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1248 msgid "" "This value controls the docstrings inheritance. If set to True the docstring" " for classes or methods, if not explicitly set, is inherited from parents." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1216 -msgid "The default is ``True``." -msgstr "" - -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1223 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1259 msgid "" -":mod:`autodoc` supports to suppress warning messages via " -":confval:`suppress_warnings`. It allows following warnings types in " -"addition:" +":mod:`autodoc` supports suppressing warning messages via " +":confval:`suppress_warnings`. It defines the following additional warnings " +"types:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1227 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1263 msgid "autodoc" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1228 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1264 msgid "autodoc.import_object" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1232 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1268 msgid "Docstring preprocessing" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1234 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1270 msgid "autodoc provides the following additional events:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1240 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1276 msgid "" "Emitted when autodoc has read and processed a docstring. *lines* is a list " "of strings -- the lines of the processed docstring -- that the event handler" @@ -1095,41 +1150,40 @@ msgstr "" msgid "Parameters" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1244 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1263 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1275 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1304 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1336 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1280 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1299 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1311 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1340 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1372 msgid "the Sphinx application object" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1245 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1276 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1337 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1281 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1312 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1373 msgid "" -"the type of the object which the docstring belongs to (one of " -"``\"module\"``, ``\"class\"``, ``\"exception\"``, ``\"function\"``, " -"``\"method\"``, ``\"attribute\"``)" +"the type of the object which the docstring belongs to (one of ``'module'``, " +"``'class'``, ``'exception'``, ``'function'``, ``'method'``, ``'attribute'``)" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1248 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1279 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1305 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1340 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1284 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1315 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1341 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1376 msgid "the fully qualified name of the object" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1249 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1264 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1280 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1306 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1341 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1285 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1300 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1316 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1342 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1377 msgid "the object itself" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1250 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1281 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1344 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1286 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1317 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1380 msgid "" "the options given to the directive: an object with attributes " "``inherited_members``, ``undoc_members``, ``show_inheritance`` and ``no-" @@ -1137,41 +1191,41 @@ msgid "" "directive" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1254 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1290 msgid "the lines of the docstring, see above" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1260 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1296 msgid "" "Emitted before autodoc formats a signature for an object. The event handler " "can modify an object to change its signature." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1265 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1301 msgid "a boolean indicates an object is bound method or not" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1271 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1307 msgid "" "Emitted when autodoc has formatted a signature for an object. The event " "handler can return a new tuple ``(signature, return_annotation)`` to change " "what Sphinx puts into the output." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1285 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1321 msgid "" -"function signature, as a string of the form ``\"(parameter_1, " -"parameter_2)\"``, or ``None`` if introspection didn't succeed and signature " +"function signature, as a string of the form ``'(parameter_1, " +"parameter_2)'``, or ``None`` if introspection didn't succeed and signature " "wasn't specified in the directive." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1288 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1324 msgid "" -"function return annotation as a string of the form ``\" -> annotation\"``, " -"or ``None`` if there is no return annotation" +"function return annotation as a string of the form ``' -> annotation'``, or " +"``None`` if there is no return annotation" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1291 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1327 msgid "" "The :mod:`sphinx.ext.autodoc` module provides factory functions for commonly" " needed docstring processing in event :event:`autodoc-process-docstring`:" @@ -1212,7 +1266,7 @@ msgid "" " be processed." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1299 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1335 msgid "" "Emitted when autodoc has read and processed a class to determine the base-" "classes. *bases* is a list of classes that the event handler can modify " @@ -1220,38 +1274,38 @@ msgid "" "if ``show-inheritance`` option given." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1307 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1343 msgid "the options given to the class directive" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1308 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1344 msgid "the list of base classes signature. see above." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1313 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1349 msgid "" "``bases`` can contain a string as a base class name. It will be processed as" " reStructuredText." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1318 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1354 msgid "Skipping members" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1320 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1356 msgid "" "autodoc allows the user to define a custom method for determining whether a " "member should be included in the documentation by using the following event:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1327 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1363 msgid "" "Emitted when autodoc has to decide whether a member should be included in " "the documentation. The member is excluded if a handler returns ``True``. " "It is included if the handler returns ``False``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1331 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1367 msgid "" "If more than one enabled extension handles the ``autodoc-skip-member`` " "event, autodoc will use the first non-``None`` value returned by a handler. " @@ -1259,7 +1313,7 @@ msgid "" "autodoc and other enabled extensions." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1342 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1378 msgid "" "a boolean indicating if autodoc will skip this member if the user handler " "does not override the decision" diff --git a/locale/ca_ES/LC_MESSAGES/changes/1.8.po b/locale/ca_ES/LC_MESSAGES/changes/1.8.po index e9fa32f6dc..65eb9454ca 100644 --- a/locale/ca_ES/LC_MESSAGES/changes/1.8.po +++ b/locale/ca_ES/LC_MESSAGES/changes/1.8.po @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-09-29 00:54+0000\n" +"POT-Creation-Date: 2024-10-03 00:49+0000\n" "PO-Revision-Date: 2024-07-31 00:36+0000\n" "Language-Team: Catalan (Spain) (https://app.transifex.com/sphinx-doc/teams/15434/ca_ES/)\n" "MIME-Version: 1.0\n" @@ -396,7 +396,7 @@ msgstr "" #: ../../sphinx/doc/changes/1.8.rst:150 msgid "" "#5421: autodoc emits deprecation warning for " -":confval:`autodoc_default_flags`" +":confval:`!autodoc_default_flags`" msgstr "" #: ../../sphinx/doc/changes/1.8.rst:151 @@ -664,7 +664,7 @@ msgid ":confval:`!source_parsers` is deprecated" msgstr "" #: ../../sphinx/doc/changes/1.8.rst:254 -msgid ":confval:`autodoc_default_flags` is deprecated" +msgid ":confval:`!autodoc_default_flags` is deprecated" msgstr "" #: ../../sphinx/doc/changes/1.8.rst:255 diff --git a/locale/ca_ES/LC_MESSAGES/changes/index.po b/locale/ca_ES/LC_MESSAGES/changes/index.po index d4a8b143d1..9a31d10596 100644 --- a/locale/ca_ES/LC_MESSAGES/changes/index.po +++ b/locale/ca_ES/LC_MESSAGES/changes/index.po @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-09-28 00:48+0000\n" +"POT-Creation-Date: 2024-10-03 00:49+0000\n" "PO-Revision-Date: 2024-07-31 00:36+0000\n" "Language-Team: Catalan (Spain) (https://app.transifex.com/sphinx-doc/teams/15434/ca_ES/)\n" "MIME-Version: 1.0\n" @@ -234,11 +234,18 @@ msgid "" ":rst:dir:`py:module` directives. Patch by Stephen Finucane." msgstr "" -#: ../../sphinx/CHANGES.rst:112 +#: ../../sphinx/CHANGES.rst:110 +msgid "" +"#12916: Restore support for custom templates named with the legacy ``_t`` " +"suffix during ``apidoc`` RST rendering (regression in 7.4.0). Patch by James" +" Addison." +msgstr "" + +#: ../../sphinx/CHANGES.rst:115 msgid "Testing" msgstr "" -#: ../../sphinx/CHANGES.rst:114 +#: ../../sphinx/CHANGES.rst:117 msgid "" "#12141: Migrate from the deprecated ``karma`` JavaScript test framework to " "the actively-maintained ``jasmine`` framework. Test coverage is unaffected." diff --git a/locale/ca_ES/LC_MESSAGES/extdev/deprecated.po b/locale/ca_ES/LC_MESSAGES/extdev/deprecated.po index de99fdb9db..2a01a0a324 100644 --- a/locale/ca_ES/LC_MESSAGES/extdev/deprecated.po +++ b/locale/ca_ES/LC_MESSAGES/extdev/deprecated.po @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-09-02 00:47+0000\n" +"POT-Creation-Date: 2024-10-03 00:50+0000\n" "PO-Revision-Date: 2019-03-09 18:04+0000\n" "Language-Team: Catalan (Spain) (https://app.transifex.com/sphinx-doc/teams/15434/ca_ES/)\n" "MIME-Version: 1.0\n" @@ -2848,7 +2848,7 @@ msgid ":meth:`~sphinx.application.Sphinx.add_js_file`" msgstr "" #: ../../sphinx/doc/extdev/deprecated.rst:1457 -msgid ":confval:`autodoc_default_flags`" +msgid ":confval:`!autodoc_default_flags`" msgstr "" #: ../../sphinx/doc/extdev/deprecated.rst:1460 diff --git a/locale/ca_ES/LC_MESSAGES/usage/domains/restructuredtext.po b/locale/ca_ES/LC_MESSAGES/usage/domains/restructuredtext.po index efac89ccee..eaa33bfc18 100644 --- a/locale/ca_ES/LC_MESSAGES/usage/domains/restructuredtext.po +++ b/locale/ca_ES/LC_MESSAGES/usage/domains/restructuredtext.po @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-09-15 00:53+0000\n" +"POT-Creation-Date: 2024-10-03 00:49+0000\n" "PO-Revision-Date: 2023-10-03 00:37+0000\n" "Language-Team: Catalan (Spain) (https://app.transifex.com/sphinx-doc/teams/15434/ca_ES/)\n" "MIME-Version: 1.0\n" @@ -75,3 +75,20 @@ msgstr "" #: ../../sphinx/doc/usage/domains/restructuredtext.rst:97 msgid "These roles are provided to refer to the described objects:" msgstr "" + +#: ../../sphinx/doc/usage/domains/restructuredtext.rst:101 +msgid "Reference directives and directive options. Examples:" +msgstr "" + +#: ../../sphinx/doc/usage/domains/restructuredtext.rst:103 +msgid "Use ``:rst:dir:`my-directive``` to reference a directive." +msgstr "" + +#: ../../sphinx/doc/usage/domains/restructuredtext.rst:104 +msgid "" +"Use ``:rst:dir:`my-directive:my-option``` to reference a directive option." +msgstr "" + +#: ../../sphinx/doc/usage/domains/restructuredtext.rst:109 +msgid "Reference a role. Example: ``:rst:role:`my-role```." +msgstr "" diff --git a/locale/ca_ES/LC_MESSAGES/usage/extensions/autodoc.po b/locale/ca_ES/LC_MESSAGES/usage/extensions/autodoc.po index 579a0dc71c..59ca43ee2a 100644 --- a/locale/ca_ES/LC_MESSAGES/usage/extensions/autodoc.po +++ b/locale/ca_ES/LC_MESSAGES/usage/extensions/autodoc.po @@ -11,7 +11,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-10-02 00:49+0000\n" +"POT-Creation-Date: 2024-10-03 00:50+0000\n" "PO-Revision-Date: 2018-06-26 15:58+0000\n" "Last-Translator: Moisès Gómez Girón , 2024\n" "Language-Team: Catalan (Spain) (https://app.transifex.com/sphinx-doc/teams/15434/ca_ES/)\n" @@ -25,26 +25,26 @@ msgstr "" msgid ":mod:`sphinx.ext.autodoc` -- Include documentation from docstrings" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:12 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:15 msgid "" "This extension can import the modules you are documenting, and pull in " "documentation from docstrings in a semi-automatic way." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:17 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:20 msgid "" ":mod:`~sphinx.ext.autodoc` **imports** the modules to be documented. If any " "modules have side effects on import, these will be executed by ``autodoc`` " "when :program:`sphinx-build` is run." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:21 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:24 msgid "" "If you document scripts (as opposed to library modules), make sure that the " "main routine is protected by an ``if __name__ == '__main__'`` condition." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:25 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:28 msgid "" "For this to work, the docstrings must of course be written in correct " "reStructuredText. You can then use all of the usual Sphinx markup in the " @@ -54,7 +54,7 @@ msgid "" "auto-generated-looking pure API documentation." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:33 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:36 msgid "" "If you prefer `NumPy`_ or `Google`_ style docstrings over reStructuredText, " "you can also enable the :mod:`napoleon ` extension. " @@ -62,25 +62,25 @@ msgid "" "reStructuredText before ``autodoc`` processes them." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:43 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:46 msgid "Getting started" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:47 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:50 msgid "Setup" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:49 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:52 msgid "" "Activate the plugin by adding ``'sphinx.ext.autodoc'`` to the " ":confval:`extensions` list in :file:`conf.py`:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:61 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:64 msgid "Ensuring the code can be imported" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:63 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:66 msgid "" ":mod:`~sphinx.ext.autodoc` analyses the code and docstrings by introspection" " after **importing the modules**. For importing to work, you have to make " @@ -90,11 +90,11 @@ msgid "" "fail)." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:70 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:73 msgid "There are two ways to ensure this:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:72 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:75 msgid "" "Use an environment that contains your package and Sphinx. This can e.g. be " "your local development environment (with an editable install), or an " @@ -103,14 +103,14 @@ msgid "" "that all dependencies are available." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:78 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:81 msgid "" "It is alternatively possible to patch the Sphinx run so that it can operate " "directly on the sources; e.g. if you want to be able to do a Sphinx build " "from a source checkout." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:82 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:85 msgid "" "Patch :data:`sys.path` in :file:`conf.py` to include your source path. For " "example if you have a repository structure with :file:`doc/conf.py` and your" @@ -118,17 +118,17 @@ msgid "" "your :file:`conf.py`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:94 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:97 msgid "" "To cope with missing dependencies, specify the missing modules in the " ":confval:`autodoc_mock_imports` setting." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:99 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:102 msgid "Usage" msgstr "Ús" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:101 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:104 msgid "" "You can now use the :ref:`autodoc-directives` to add formatted documentation" " for Python code elements like functions, classes, modules, etc. For " @@ -136,48 +136,48 @@ msgid "" "docstring from the source file, you'd write:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:110 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:113 msgid "" "You can also document whole classes or even modules automatically, using " "member options for the auto directives, like:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:119 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:122 msgid "" "As a hint to autodoc extension, you can put a ``::`` separator between the " "module name and the object name to let autodoc know the correct module, if " "it is ambiguous:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:129 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:132 msgid "Marking objects as public or private" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:131 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:134 msgid "" "autodoc considers a member private if its docstring contains ``:meta " "private:`` in its :ref:`info-field-lists`. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:145 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:148 msgid "" "autodoc considers a member public if its docstring contains ``:meta " "public:`` in its :ref:`info-field-lists`, even if it starts with an " "underscore. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:160 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:163 msgid "" "autodoc considers a variable member does not have any default value if its " "docstring contains ``:meta hide-value:`` in its :ref:`info-field-lists`. " "Example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:174 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:177 msgid "Doc comments and docstrings" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:176 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:179 msgid "" "Python has no built-in support for docstrings for module data members or " "class attributes. To allow documenting these, ``autodoc`` recognises a " @@ -185,7 +185,7 @@ msgid "" " 'documentation comment'." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:181 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:184 msgid "" "These comments start with a colon and an optional space character, ``'#:'`` " "or ``'#: '``. To be recognised, the comments must appear either on the same " @@ -194,28 +194,28 @@ msgid "" "definition." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:188 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:191 msgid "" "For example, all three of the following variables have valid doc-comments:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:202 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:205 msgid "" "Alternatively, ``autodoc`` can recognise a docstring on the line immediately" " following the definition." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:205 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:208 msgid "" "In the the following class definition, all attributes have documentation " "recognised by ``autodoc``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:233 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:236 msgid "Directives" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:235 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:238 msgid "" ":mod:`autodoc` provides several directives that are versions of the usual " ":rst:dir:`py:module`, :rst:dir:`py:class` and so forth. On parsing time, " @@ -224,24 +224,24 @@ msgid "" ":rst:dir:`py:module`, :rst:dir:`py:class` etc. directive." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:244 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:247 msgid "" "Just as :rst:dir:`py:class` respects the current :rst:dir:`py:module`, " ":rst:dir:`autoclass` will also do so. Likewise, :rst:dir:`automethod` will " "respect the current :rst:dir:`py:class`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:250 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:253 msgid "Default directive options" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:252 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:255 msgid "" "To make any of the options described below the default, use the " ":confval:`autodoc_default_options` dictionary in :file:`conf.py`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:255 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:258 msgid "" "If using defaults for the ``:members:``, ``:exclude-members:``, ``:private-" "members:``, or ``:special-members:`` options, setting the option on a " @@ -250,111 +250,111 @@ msgid "" "(``+``), as follows:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:269 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:272 msgid "" "If using :confval:`autodoc_default_options`, the defaults can be disabled " "per-directive with the negated form, :samp:`:no-{option}:` as an option of " "the directive For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:281 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:284 msgid "Automatically document modules" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:285 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:288 msgid "" "Document a module. By default, the directive only inserts the docstring of " "the module itself:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:292 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:526 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:792 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:866 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:295 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:531 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:797 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:871 msgid "will produce source like this:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:300 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:534 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:303 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:539 msgid "" "The directive can also contain content of its own, which will be inserted " "into the resulting non-auto directive source after the docstring (but before" " any automatic member documentation)." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:304 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:538 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:878 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:307 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:543 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:883 msgid "" "Therefore, you can also mix automatic and non-automatic member " "documentation, as follows:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:317 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:567 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:844 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:894 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:320 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:572 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:849 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:899 msgid "Options" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:321 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:324 msgid "" "Do not generate an index entry for the documented module or any auto-" "documented members." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:329 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:332 msgid "" "Indicate platforms on which the module is available. This is identical to " ":rst:dir:`py:module`'s ``:platform:`` option." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:335 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:338 msgid "" "A sentence describing the module's purpose. This is identical to " ":rst:dir:`py:module`'s ``:synopsis:`` option." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:343 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:346 msgid "" "Mark a module as deprecated. This is identical to :rst:dir:`py:module`'s " "``:deprecated:`` option." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:351 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:354 msgid "Do not use ``__all__`` when analysing the module to document." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:356 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:600 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:359 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:605 msgid "Options for selecting members to document" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:360 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:363 msgid "Generate automatic documentation for all members of the target module:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:367 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:370 msgid "" "By default, ``autodoc`` only includes public members with a docstring or " ":ref:`doc-comment ` (``#:``). If ``__all__`` exists, it will be" -" used to define which members are public, unless the ``:ignore-module-all:``" -" option is set." +" used to define which members are public, unless the :rst:dir:`:ignore-" +"module-all: ` option is set." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:372 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:615 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:376 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:620 msgid "" "To only document certain members, an explicit comma-separated list may be " "used as the argument to ``:members:``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:383 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:626 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:387 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:631 msgid "Exclude the given names from the members to document. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:397 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:401 msgid "" "To prevent documentation of imported classes or functions, in an " ":rst:dir:`!automodule` directive with the ``members`` option set, only " @@ -362,198 +362,197 @@ msgid "" "name given to ``automodule`` will be documented." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:402 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:406 msgid "" "Set the ``imported-members`` option if you want to prevent this behavior and" " document all available members." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:405 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:409 msgid "" "Note that attributes from imported modules will not be documented, because " "attribute documentation is discovered by parsing the source file of the " "current module." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:414 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:418 msgid "" "Generate automatic documentation for members of the target module that don't" " have a docstring or doc-comment. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:427 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:431 msgid "" "Generate automatic documentation for private members of the target module. " "This includes names with a leading underscore (e.g. ``_private``) and those " "members explicitly marked as private with ``:meta private:``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:437 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:703 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:441 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:708 msgid "" "To only document certain private members, an explicit comma-separated list " "may be used as the argument to ``:private-members:``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:447 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:475 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:741 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:451 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:479 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:746 msgid "The option can now take a comma-separated list of arguments." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:453 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:457 msgid "" "Generate automatic documentation for special members of the target module, " -"also known as :ref:`\"dunder\" names `. This includes " -"all names enclosed with a double-underscore, e.g. ``__special__``:" +"also known as :ref:`'dunder' names `. This includes all" +" names enclosed with a double-underscore, e.g. ``__special__``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:464 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:730 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:468 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:735 msgid "" "To only document certain special members, an explicit comma-separated list " "may be used as the argument to ``:special-members:``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:479 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:745 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:483 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:750 msgid "Options for documented members" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:483 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:749 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:487 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:754 msgid "" "Choose the ordering of automatically documented members (default: " "``alphabetical``). This overrides the :confval:`autodoc_member_order` " "setting." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:487 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:491 msgid "``alphabetical``: Use simple alphabetical order." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:489 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:493 msgid "" "``groupwise``: Group by object type (class, function, etc), use alphabetical" " order within groups." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:492 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:496 msgid "" "``bysource``: Use the order of objects in the module's source. The " "``__all__`` variable can be used to override this order." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:496 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:762 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:980 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:500 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:767 msgid "" "Note that for source order, the module must be a Python module with the " "source code available." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:500 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:766 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:504 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:771 msgid "Support the ``'bysource'`` option." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:506 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:510 msgid "" -"Enable the ``:show-inheritance:`` option for all members of the module, if " -"``:members:`` is enabled." +"Enable the :rst:dir:`:show-inheritance: ` option" +" for all members of the module, if ``:members:`` is enabled." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:513 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:518 msgid "Automatically document classes or exceptions" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:518 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:523 msgid "" -"Document a class. For exception classes, prefer ``autoexception``. By " +"Document a class. For exception classes, prefer ``.. autoexception::``. By " "default, the directive only inserts the docstring of the class itself:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:551 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:828 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:556 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:833 msgid "Advanced usage" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:552 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:829 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:557 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:834 msgid "" "It is possible to override the signature for explicitly documented callable " "objects (functions, methods, classes) with the regular syntax that will " "override the signature gained from introspection:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:562 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:839 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:567 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:844 msgid "" "This is useful if the signature from the method is hidden by a decorator." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:571 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:898 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:576 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:903 msgid "" "Do not generate an index entry for the documented class or any auto-" "documented members." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:579 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:584 msgid "" "Select which docstring will be used for the main body of the directive. This" " overrides the global value of :confval:`autoclass_content`. The possible " "values are:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:583 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:588 msgid "" "``class``: Only use the class's docstring. The :meth:`!__init__` method can " "be separately documented using the ``:members:`` option or " ":rst:dir:`automethod`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:587 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:592 msgid "``init``: Only use the docstring of the :meth:`!__init__` method." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:589 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:594 msgid "" -"``both`` Use both, appending the docstring of the :meth:`!__init__` method " +"``both``: Use both, appending the docstring of the :meth:`!__init__` method " "to the class's docstring." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:593 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:598 msgid "" "If the :meth:`!__init__` method doesn't exist or has a blank docstring, " "``autodoc`` will attempt to use the :meth:`!__new__` method's docstring, if " "it exists and is not blank." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:604 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:609 msgid "Generate automatic documentation for all members of the target class:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:611 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:616 msgid "" "By default, ``autodoc`` only includes public members with a docstring or " ":ref:`doc-comment ` (``#:``) that are attributes of the target " "class (i.e. not inherited)." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:640 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:645 msgid "" "To generate automatic documentation for members inherited from base classes," " use the ``:inherited-members:`` option:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:649 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:654 msgid "" "This can be combined with the ``:undoc-members:`` option to generate " "automatic documentation for *all* available members of the class." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:652 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:657 msgid "" "The members of classes listed in the argument to ``:inherited-members:`` are" " excluded from the automatic documentation. This defaults to " @@ -562,105 +561,105 @@ msgid "" "as the argument." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:658 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:663 msgid "" "For example; If your class ``MyList`` is derived from ``list`` class and you" " don't want to document ``list.__len__()``, you should specify a option " "``:inherited-members: list`` to avoid special members of list class." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:664 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:669 msgid "" "Should any of the inherited members use a format other than reStructuredText" " for their docstrings, there may be markup warnings or errors." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:670 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:675 msgid "" "``:inherited-members:`` now takes the name of a base class to exclude as an " "argument." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:674 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:679 msgid "A comma separated list of base class names can be used." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:680 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:685 msgid "" "Generate automatic documentation for members of the target class that don't " "have a docstring or doc-comment. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:693 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:698 msgid "" "Generate automatic documentation for private members of the target class. " "This includes names with a leading underscore (e.g. ``_private``) and those " "members explicitly marked as private with ``:meta private:``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:713 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:718 msgid "The option can now take arguments." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:719 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:724 msgid "" "Generate automatic documentation for special members of the target class, " -"also known as :ref:`\"dunder\" names `. This includes " -"all names enclosed with a double-underscore, e.g. ``__special__``:" +"also known as :ref:`'dunder' names `. This includes all" +" names enclosed with a double-underscore, e.g. ``__special__``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:753 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:758 msgid "``'alphabetical'``: Use simple alphabetical order." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:755 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:760 msgid "" "``'groupwise'``: Group by object type (class, function, etc), use " "alphabetical order within groups." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:758 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:763 msgid "" "``'bysource'``: Use the order of objects in the module's source. The " "``__all__`` variable can be used to override this order." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:772 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:777 msgid "Insert the class's base classes after the class signature." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:778 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:783 msgid "Automatically document function-like objects" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:785 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:790 msgid "" "Document a function, method, property, or decorator. By default, the " "directive only inserts the docstring of the function itself:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:800 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:874 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:805 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:879 msgid "" "The directive can also contain content of its own, which will be inserted " "into the resulting non-auto directive source after the docstring." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:804 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:809 msgid "" "Therefore, you can also mix automatic and non-automatic documentation, as " "follows:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:813 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:818 msgid ":rst:dir:`autodecorator`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:815 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:820 msgid ":rst:dir:`autoproperty`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:820 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:825 msgid "" "If you document decorated functions or methods, keep in mind that " "``autodoc`` retrieves its docstrings by importing the module and inspecting " @@ -669,30 +668,30 @@ msgid "" "the original ``__doc__`` to the new function." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:848 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:853 msgid "Do not generate an index entry for the documented function." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:854 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:859 msgid "Automatically document attributes or data" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:859 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:864 msgid "" "Document a module level variable or constant ('data') or class attribute. By" " default, the directive only inserts the docstring of the variable itself:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:887 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:892 msgid "" ":rst:dir:`autodata` and :rst:dir:`autoattribute` can now extract docstrings." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:890 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:895 msgid "Doc-comments are now allowed on the same line of an assignment." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:908 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:913 msgid "" "By default, ``autodoc`` attempts to obtain the type annotation and value of " "the variable by introspection, displaying it after the variable's name. To " @@ -700,165 +699,225 @@ msgid "" "argument to ``annotation``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:914 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:919 msgid "" "For example, if the runtime value of ``FILE_MODE`` is ``0o755``, the " "displayed value will be ``493`` (as ``oct(493) == '0o755'``). This can be " "fixed by setting ``:annotation: = 0o755``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:918 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:923 msgid "" -"If ``annotation`` is used without arguments, no value or type hint will be " -"shown for the variable." +"If ``:annotation:`` is used without arguments, no value or type hint will be" +" shown for the variable." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:925 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:930 msgid "" -"To display the type hint of the variable without a value, use the ``no-" -"value`` option. If both the ``annotation`` and ``no-value`` options are " -"used, ``no-value`` has no effect." +"To display the type hint of the variable without a value, use the ``:no-" +"value:`` option. If both the ``:annotation:`` and ``:no-value:`` options are" +" used, ``:no-value:`` has no effect." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:932 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:937 msgid "Configuration" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:934 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:939 msgid "There are also config values that you can set:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:938 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:0 +msgid "Type" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:0 +msgid "Default" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:945 msgid "" "This value selects what content will be inserted into the main body of an " ":rst:dir:`autoclass` directive. The possible values are:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:941 -msgid "``\"class\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:948 +msgid "``'class'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:942 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:949 msgid "" -"Only the class' docstring is inserted. This is the default. You can still " -"document ``__init__`` as a separate method using :rst:dir:`automethod` or " -"the ``members`` option to :rst:dir:`autoclass`." +"Only the class' docstring is inserted. You can still document ``__init__`` " +"as a separate method using :rst:dir:`automethod` or the ``members`` option " +"to :rst:dir:`autoclass`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:945 -msgid "``\"both\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:952 +msgid "``'both'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:946 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:953 msgid "" "Both the class' and the ``__init__`` method's docstring are concatenated and" " inserted." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:948 -msgid "``\"init\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:955 +msgid "``'init'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:949 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:956 msgid "Only the ``__init__`` method's docstring is inserted." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:953 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:960 msgid "" "If the class has no ``__init__`` method or if the ``__init__`` method's " "docstring is empty, but the class has a ``__new__`` method's docstring, it " "is used instead." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:961 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:970 msgid "" "This value selects how the signature will be displayed for the class defined" " by :rst:dir:`autoclass` directive. The possible values are:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:964 -msgid "``\"mixed\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:973 +msgid "``'mixed'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:965 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:974 msgid "Display the signature with the class name." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:966 -msgid "``\"separated\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:975 +msgid "``'separated'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:967 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:976 msgid "Display the signature as a method." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:969 -msgid "The default is ``\"mixed\"``." -msgstr "" - -#: ../../sphinx/doc/usage/extensions/autodoc.rst:975 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:984 msgid "" -"This value selects if automatically documented members are sorted " -"alphabetical (value ``'alphabetical'``), by member type (value " -"``'groupwise'``) or by source order (value ``'bysource'``). The default is " -"alphabetical." +"Define the order in which :rst:dir:`automodule` and :rst:dir:`autoclass` " +"members are listed. Supported values are:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:984 -msgid "Support for ``'bysource'``." +#: ../../sphinx/doc/usage/extensions/autodoc.rst:987 +msgid "``'alphabetical'``: Use alphabetical order." msgstr "" #: ../../sphinx/doc/usage/extensions/autodoc.rst:989 +msgid "``'groupwise'``: order by member type. The order is:" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:991 +msgid "for modules, exceptions, classes, functions, data" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:992 +msgid "for classes: methods, then properties and attributes" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:994 +msgid "Members are ordered alphabetically within groups." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:996 msgid "" -"This value is a list of autodoc directive flags that should be automatically" -" applied to all autodoc directives. The supported flags are ``'members'``, " -"``'undoc-members'``, ``'private-members'``, ``'special-members'``, " -"``'inherited-members'``, ``'show-inheritance'``, ``'ignore-module-all'`` and" -" ``'exclude-members'``." +"``'bysource'``: Use the order in which the members appear in the source " +"code. This requires that the module must be a Python module with the source " +"code available." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:999 -msgid "Integrated into :confval:`autodoc_default_options`." +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1002 +msgid "Support for ``'bysource'``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1003 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1009 msgid "" "The default options for autodoc directives. They are applied to all autodoc" " directives automatically. It must be a dictionary which maps option names " "to the values. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1017 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1023 msgid "" "Setting ``None`` or ``True`` to the value is equivalent to giving only the " "option name to the directives." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1020 -msgid "" -"The supported options are ``'members'``, ``'member-order'``, ``'undoc-" -"members'``, ``'private-members'``, ``'special-members'``, ``'inherited-" -"members'``, ``'show-inheritance'``, ``'ignore-module-all'``, ``'imported-" -"members'``, ``'exclude-members'``, ``'class-doc-from'`` and ``'no-value'``." +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1026 +msgid "The supported options are:" msgstr "" #: ../../sphinx/doc/usage/extensions/autodoc.rst:1028 -msgid "Accepts ``True`` as a value." +msgid "``'members'``: See :rst:dir:`automodule:members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1029 +msgid "``'undoc-members'`` See :rst:dir:`automodule:undoc-members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1030 +msgid "``'private-members'``: See :rst:dir:`automodule:private-members`." msgstr "" #: ../../sphinx/doc/usage/extensions/autodoc.rst:1031 -msgid "Added ``'imported-members'``." +msgid "``'special-members'``: See :rst:dir:`automodule:special-members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1032 +msgid "``'inherited-members'``: See :rst:dir:`autoclass:inherited-members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1033 +msgid "``'imported-members'``: See :rst:dir:`automodule:imported-members`." msgstr "" #: ../../sphinx/doc/usage/extensions/autodoc.rst:1034 -msgid "Added ``'class-doc-from'``." +msgid "``'exclude-members'``: See :rst:dir:`automodule:exclude-members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1035 +msgid "``'ignore-module-all'``: See :rst:dir:`automodule:ignore-module-all`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1036 +msgid "``'member-order'``: See :rst:dir:`automodule:member-order`." msgstr "" #: ../../sphinx/doc/usage/extensions/autodoc.rst:1037 +msgid "``'show-inheritance'``: See :rst:dir:`autoclass:show-inheritance`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1038 +msgid "``'class-doc-from'``: See :rst:dir:`autoclass:class-doc-from`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1039 +msgid "``'no-value'``: See :rst:dir:`autodata:no-value`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1043 +msgid "Accepts ``True`` as a value." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1046 +msgid "Added ``'imported-members'``." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1049 +msgid "Added ``'class-doc-from'``." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1052 msgid "Added ``'no-value'``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1042 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1059 msgid "" "Functions imported from C modules cannot be introspected, and therefore the " "signature for such functions cannot be automatically determined. However, " @@ -866,7 +925,7 @@ msgid "" "the function's docstring." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1047 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1064 msgid "" "If this boolean value is set to ``True`` (which is the default), autodoc " "will look at the first line of the docstring for functions and methods, and " @@ -874,22 +933,22 @@ msgid "" "from the docstring content." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1052 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1069 msgid "" "autodoc will continue to look for multiple signature lines, stopping at the " "first line that does not look like a signature. This is useful for declaring" " overloaded function signatures." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1059 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1076 msgid "Support overloaded signatures" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1063 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1080 msgid "Overloaded signatures do not need to be separated by a backslash" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1067 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1086 msgid "" "This value contains a list of modules to be mocked up. This is useful when " "some external dependencies are not met at build time and break the building " @@ -897,198 +956,194 @@ msgid "" "themselves and omit the sub-modules:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1076 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1095 msgid "Will mock all imports under the ``django`` package." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1080 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1099 msgid "" "This config value only requires to declare the top-level modules that should" " be mocked." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1086 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1107 msgid "" "This value controls how to represent typehints. The setting takes the " "following values:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1089 -msgid "``'signature'`` -- Show typehints in the signature (default)" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1110 +msgid "``'signature'`` -- Show typehints in the signature" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1090 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1111 msgid "" "``'description'`` -- Show typehints as content of the function or method The" " typehints of overloaded functions or methods will still be represented in " "the signature." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1093 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1114 msgid "``'none'`` -- Do not show typehints" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1094 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1115 msgid "" "``'both'`` -- Show typehints in the signature and as content of the function" " or method" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1097 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1118 msgid "" "Overloaded functions or methods will not have typehints included in the " "description because it is impossible to accurately represent all possible " "overloads as a list of parameters." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1104 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1125 msgid "New option ``'description'`` is added." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1108 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1129 msgid "New option ``'both'`` is added." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1112 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1135 msgid "" "This value controls whether the types of undocumented parameters and return " -"values are documented when ``autodoc_typehints`` is set to ``description``." +"values are documented when :confval:`autodoc_typehints` is set to " +"``'description'``. Supported values:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1115 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1140 msgid "" -"The default value is ``\"all\"``, meaning that types are documented for all " -"parameters and return values, whether they are documented or not." +"``'all'``: Types are documented for all parameters and return values, " +"whether they are documented or not." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1118 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1143 msgid "" -"When set to ``\"documented\"``, types will only be documented for a " -"parameter or a return value that is already documented by the docstring." +"``'documented'``: Types will only be documented for a parameter or a return " +"value that is already documented by the docstring." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1121 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1146 msgid "" -"With ``\"documented_params\"``, parameter types will only be annotated if " -"the parameter is documented in the docstring. The return type is always " +"``'documented_params'``: Parameter types will only be annotated if the " +"parameter is documented in the docstring. The return type is always " "annotated (except if it is ``None``)." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1129 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1155 msgid "New option ``'documented_params'`` is added." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1133 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1161 msgid "" "A dictionary for users defined `type aliases`__ that maps a type name to the" " full-qualified object name. It is used to keep type aliases not evaluated " -"in the document. Defaults to empty (``{}``)." +"in the document." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1137 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1165 msgid "" "The type aliases are only available if your program enables :pep:`Postponed " "Evaluation of Annotations (PEP 563) <563>` feature via ``from __future__ " "import annotations``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1141 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1169 msgid "For example, there is code using a type alias:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1152 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1180 msgid "" "If ``autodoc_type_aliases`` is not set, autodoc will generate internal mark-" "up from this code as following:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1161 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1189 msgid "" "If you set ``autodoc_type_aliases`` as ``{'AliasType': " "'your.module.AliasType'}``, it generates the following document internally:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1176 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1206 msgid "" "This value controls the format of typehints. The setting takes the " "following values:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1179 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1209 msgid "" "``'fully-qualified'`` -- Show the module name and its name of typehints" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1180 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1210 msgid "" "``'short'`` -- Suppress the leading module names of the typehints (e.g. " -"``io.StringIO`` -> ``StringIO``) (default)" +"``io.StringIO`` -> ``StringIO``)" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1187 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1217 msgid "The default setting was changed to ``'short'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1191 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1223 msgid "" "If True, the default argument values of functions will be not evaluated on " "generating document. It preserves them as is in the source code." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1196 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1228 msgid "" "Added as an experimental feature. This will be integrated into autodoc core" " in the future." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1201 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1235 msgid "" "This value controls the behavior of :option:`sphinx-build --fail-on-warning`" " during importing modules. If ``False`` is given, autodoc forcedly " -"suppresses the error if the imported module emits warnings. By default, " -"``True``." +"suppresses the error if the imported module emits warnings." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1206 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1240 msgid "" "This option now has no effect as :option:`!--fail-on-warning` no longer " "exits early." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1212 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1248 msgid "" "This value controls the docstrings inheritance. If set to True the docstring" " for classes or methods, if not explicitly set, is inherited from parents." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1216 -msgid "The default is ``True``." -msgstr "" - -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1223 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1259 msgid "" -":mod:`autodoc` supports to suppress warning messages via " -":confval:`suppress_warnings`. It allows following warnings types in " -"addition:" +":mod:`autodoc` supports suppressing warning messages via " +":confval:`suppress_warnings`. It defines the following additional warnings " +"types:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1227 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1263 msgid "autodoc" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1228 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1264 msgid "autodoc.import_object" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1232 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1268 msgid "Docstring preprocessing" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1234 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1270 msgid "autodoc provides the following additional events:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1240 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1276 msgid "" "Emitted when autodoc has read and processed a docstring. *lines* is a list " "of strings -- the lines of the processed docstring -- that the event handler" @@ -1099,41 +1154,40 @@ msgstr "" msgid "Parameters" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1244 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1263 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1275 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1304 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1336 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1280 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1299 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1311 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1340 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1372 msgid "the Sphinx application object" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1245 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1276 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1337 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1281 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1312 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1373 msgid "" -"the type of the object which the docstring belongs to (one of " -"``\"module\"``, ``\"class\"``, ``\"exception\"``, ``\"function\"``, " -"``\"method\"``, ``\"attribute\"``)" +"the type of the object which the docstring belongs to (one of ``'module'``, " +"``'class'``, ``'exception'``, ``'function'``, ``'method'``, ``'attribute'``)" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1248 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1279 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1305 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1340 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1284 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1315 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1341 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1376 msgid "the fully qualified name of the object" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1249 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1264 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1280 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1306 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1341 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1285 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1300 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1316 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1342 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1377 msgid "the object itself" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1250 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1281 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1344 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1286 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1317 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1380 msgid "" "the options given to the directive: an object with attributes " "``inherited_members``, ``undoc_members``, ``show_inheritance`` and ``no-" @@ -1141,41 +1195,41 @@ msgid "" "directive" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1254 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1290 msgid "the lines of the docstring, see above" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1260 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1296 msgid "" "Emitted before autodoc formats a signature for an object. The event handler " "can modify an object to change its signature." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1265 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1301 msgid "a boolean indicates an object is bound method or not" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1271 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1307 msgid "" "Emitted when autodoc has formatted a signature for an object. The event " "handler can return a new tuple ``(signature, return_annotation)`` to change " "what Sphinx puts into the output." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1285 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1321 msgid "" -"function signature, as a string of the form ``\"(parameter_1, " -"parameter_2)\"``, or ``None`` if introspection didn't succeed and signature " +"function signature, as a string of the form ``'(parameter_1, " +"parameter_2)'``, or ``None`` if introspection didn't succeed and signature " "wasn't specified in the directive." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1288 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1324 msgid "" -"function return annotation as a string of the form ``\" -> annotation\"``, " -"or ``None`` if there is no return annotation" +"function return annotation as a string of the form ``' -> annotation'``, or " +"``None`` if there is no return annotation" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1291 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1327 msgid "" "The :mod:`sphinx.ext.autodoc` module provides factory functions for commonly" " needed docstring processing in event :event:`autodoc-process-docstring`:" @@ -1216,7 +1270,7 @@ msgid "" " be processed." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1299 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1335 msgid "" "Emitted when autodoc has read and processed a class to determine the base-" "classes. *bases* is a list of classes that the event handler can modify " @@ -1224,38 +1278,38 @@ msgid "" "if ``show-inheritance`` option given." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1307 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1343 msgid "the options given to the class directive" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1308 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1344 msgid "the list of base classes signature. see above." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1313 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1349 msgid "" "``bases`` can contain a string as a base class name. It will be processed as" " reStructuredText." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1318 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1354 msgid "Skipping members" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1320 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1356 msgid "" "autodoc allows the user to define a custom method for determining whether a " "member should be included in the documentation by using the following event:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1327 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1363 msgid "" "Emitted when autodoc has to decide whether a member should be included in " "the documentation. The member is excluded if a handler returns ``True``. " "It is included if the handler returns ``False``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1331 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1367 msgid "" "If more than one enabled extension handles the ``autodoc-skip-member`` " "event, autodoc will use the first non-``None`` value returned by a handler. " @@ -1263,7 +1317,7 @@ msgid "" "autodoc and other enabled extensions." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1342 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1378 msgid "" "a boolean indicating if autodoc will skip this member if the user handler " "does not override the decision" diff --git a/locale/de/LC_MESSAGES/changes/1.8.po b/locale/de/LC_MESSAGES/changes/1.8.po index 45bacd7955..e4ee9b2f1e 100644 --- a/locale/de/LC_MESSAGES/changes/1.8.po +++ b/locale/de/LC_MESSAGES/changes/1.8.po @@ -11,7 +11,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-10-01 00:54+0000\n" +"POT-Creation-Date: 2024-10-03 00:49+0000\n" "PO-Revision-Date: 2024-07-31 00:36+0000\n" "Last-Translator: Georg Brandl , 2024\n" "Language-Team: German (https://app.transifex.com/sphinx-doc/teams/15434/de/)\n" @@ -400,7 +400,7 @@ msgstr "" #: ../../sphinx/doc/changes/1.8.rst:150 msgid "" "#5421: autodoc emits deprecation warning for " -":confval:`autodoc_default_flags`" +":confval:`!autodoc_default_flags`" msgstr "" #: ../../sphinx/doc/changes/1.8.rst:151 @@ -668,7 +668,7 @@ msgid ":confval:`!source_parsers` is deprecated" msgstr "" #: ../../sphinx/doc/changes/1.8.rst:254 -msgid ":confval:`autodoc_default_flags` is deprecated" +msgid ":confval:`!autodoc_default_flags` is deprecated" msgstr "" #: ../../sphinx/doc/changes/1.8.rst:255 diff --git a/locale/de/LC_MESSAGES/changes/index.po b/locale/de/LC_MESSAGES/changes/index.po index 134cbec147..deba5b4142 100644 --- a/locale/de/LC_MESSAGES/changes/index.po +++ b/locale/de/LC_MESSAGES/changes/index.po @@ -11,7 +11,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-09-28 00:48+0000\n" +"POT-Creation-Date: 2024-10-03 00:49+0000\n" "PO-Revision-Date: 2024-07-31 00:36+0000\n" "Last-Translator: Georg Brandl , 2024\n" "Language-Team: German (https://app.transifex.com/sphinx-doc/teams/15434/de/)\n" @@ -238,11 +238,18 @@ msgid "" ":rst:dir:`py:module` directives. Patch by Stephen Finucane." msgstr "" -#: ../../sphinx/CHANGES.rst:112 +#: ../../sphinx/CHANGES.rst:110 +msgid "" +"#12916: Restore support for custom templates named with the legacy ``_t`` " +"suffix during ``apidoc`` RST rendering (regression in 7.4.0). Patch by James" +" Addison." +msgstr "" + +#: ../../sphinx/CHANGES.rst:115 msgid "Testing" msgstr "" -#: ../../sphinx/CHANGES.rst:114 +#: ../../sphinx/CHANGES.rst:117 msgid "" "#12141: Migrate from the deprecated ``karma`` JavaScript test framework to " "the actively-maintained ``jasmine`` framework. Test coverage is unaffected." diff --git a/locale/de/LC_MESSAGES/extdev/deprecated.po b/locale/de/LC_MESSAGES/extdev/deprecated.po index 50e7eb58bb..7ea6c8c2e1 100644 --- a/locale/de/LC_MESSAGES/extdev/deprecated.po +++ b/locale/de/LC_MESSAGES/extdev/deprecated.po @@ -11,7 +11,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-09-02 00:47+0000\n" +"POT-Creation-Date: 2024-10-03 00:50+0000\n" "PO-Revision-Date: 2019-03-09 18:04+0000\n" "Last-Translator: Georg Brandl , 2021\n" "Language-Team: German (https://app.transifex.com/sphinx-doc/teams/15434/de/)\n" @@ -2852,7 +2852,7 @@ msgid ":meth:`~sphinx.application.Sphinx.add_js_file`" msgstr "" #: ../../sphinx/doc/extdev/deprecated.rst:1457 -msgid ":confval:`autodoc_default_flags`" +msgid ":confval:`!autodoc_default_flags`" msgstr "" #: ../../sphinx/doc/extdev/deprecated.rst:1460 diff --git a/locale/de/LC_MESSAGES/usage/domains/restructuredtext.po b/locale/de/LC_MESSAGES/usage/domains/restructuredtext.po index c3065b0d5c..3a4a70df5f 100644 --- a/locale/de/LC_MESSAGES/usage/domains/restructuredtext.po +++ b/locale/de/LC_MESSAGES/usage/domains/restructuredtext.po @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-09-15 00:53+0000\n" +"POT-Creation-Date: 2024-10-03 00:49+0000\n" "PO-Revision-Date: 2023-10-03 00:37+0000\n" "Language-Team: German (https://app.transifex.com/sphinx-doc/teams/15434/de/)\n" "MIME-Version: 1.0\n" @@ -75,3 +75,20 @@ msgstr "" #: ../../sphinx/doc/usage/domains/restructuredtext.rst:97 msgid "These roles are provided to refer to the described objects:" msgstr "" + +#: ../../sphinx/doc/usage/domains/restructuredtext.rst:101 +msgid "Reference directives and directive options. Examples:" +msgstr "" + +#: ../../sphinx/doc/usage/domains/restructuredtext.rst:103 +msgid "Use ``:rst:dir:`my-directive``` to reference a directive." +msgstr "" + +#: ../../sphinx/doc/usage/domains/restructuredtext.rst:104 +msgid "" +"Use ``:rst:dir:`my-directive:my-option``` to reference a directive option." +msgstr "" + +#: ../../sphinx/doc/usage/domains/restructuredtext.rst:109 +msgid "Reference a role. Example: ``:rst:role:`my-role```." +msgstr "" diff --git a/locale/de/LC_MESSAGES/usage/extensions/autodoc.po b/locale/de/LC_MESSAGES/usage/extensions/autodoc.po index dcb9d4f3b0..a4004cf974 100644 --- a/locale/de/LC_MESSAGES/usage/extensions/autodoc.po +++ b/locale/de/LC_MESSAGES/usage/extensions/autodoc.po @@ -11,7 +11,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-10-02 00:49+0000\n" +"POT-Creation-Date: 2024-10-03 00:50+0000\n" "PO-Revision-Date: 2018-06-26 15:58+0000\n" "Last-Translator: Georg Brandl , 2018\n" "Language-Team: German (https://app.transifex.com/sphinx-doc/teams/15434/de/)\n" @@ -25,26 +25,26 @@ msgstr "" msgid ":mod:`sphinx.ext.autodoc` -- Include documentation from docstrings" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:12 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:15 msgid "" "This extension can import the modules you are documenting, and pull in " "documentation from docstrings in a semi-automatic way." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:17 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:20 msgid "" ":mod:`~sphinx.ext.autodoc` **imports** the modules to be documented. If any " "modules have side effects on import, these will be executed by ``autodoc`` " "when :program:`sphinx-build` is run." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:21 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:24 msgid "" "If you document scripts (as opposed to library modules), make sure that the " "main routine is protected by an ``if __name__ == '__main__'`` condition." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:25 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:28 msgid "" "For this to work, the docstrings must of course be written in correct " "reStructuredText. You can then use all of the usual Sphinx markup in the " @@ -54,7 +54,7 @@ msgid "" "auto-generated-looking pure API documentation." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:33 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:36 msgid "" "If you prefer `NumPy`_ or `Google`_ style docstrings over reStructuredText, " "you can also enable the :mod:`napoleon ` extension. " @@ -62,25 +62,25 @@ msgid "" "reStructuredText before ``autodoc`` processes them." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:43 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:46 msgid "Getting started" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:47 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:50 msgid "Setup" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:49 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:52 msgid "" "Activate the plugin by adding ``'sphinx.ext.autodoc'`` to the " ":confval:`extensions` list in :file:`conf.py`:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:61 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:64 msgid "Ensuring the code can be imported" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:63 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:66 msgid "" ":mod:`~sphinx.ext.autodoc` analyses the code and docstrings by introspection" " after **importing the modules**. For importing to work, you have to make " @@ -90,11 +90,11 @@ msgid "" "fail)." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:70 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:73 msgid "There are two ways to ensure this:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:72 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:75 msgid "" "Use an environment that contains your package and Sphinx. This can e.g. be " "your local development environment (with an editable install), or an " @@ -103,14 +103,14 @@ msgid "" "that all dependencies are available." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:78 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:81 msgid "" "It is alternatively possible to patch the Sphinx run so that it can operate " "directly on the sources; e.g. if you want to be able to do a Sphinx build " "from a source checkout." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:82 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:85 msgid "" "Patch :data:`sys.path` in :file:`conf.py` to include your source path. For " "example if you have a repository structure with :file:`doc/conf.py` and your" @@ -118,17 +118,17 @@ msgid "" "your :file:`conf.py`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:94 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:97 msgid "" "To cope with missing dependencies, specify the missing modules in the " ":confval:`autodoc_mock_imports` setting." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:99 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:102 msgid "Usage" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:101 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:104 msgid "" "You can now use the :ref:`autodoc-directives` to add formatted documentation" " for Python code elements like functions, classes, modules, etc. For " @@ -136,48 +136,48 @@ msgid "" "docstring from the source file, you'd write:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:110 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:113 msgid "" "You can also document whole classes or even modules automatically, using " "member options for the auto directives, like:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:119 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:122 msgid "" "As a hint to autodoc extension, you can put a ``::`` separator between the " "module name and the object name to let autodoc know the correct module, if " "it is ambiguous:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:129 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:132 msgid "Marking objects as public or private" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:131 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:134 msgid "" "autodoc considers a member private if its docstring contains ``:meta " "private:`` in its :ref:`info-field-lists`. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:145 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:148 msgid "" "autodoc considers a member public if its docstring contains ``:meta " "public:`` in its :ref:`info-field-lists`, even if it starts with an " "underscore. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:160 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:163 msgid "" "autodoc considers a variable member does not have any default value if its " "docstring contains ``:meta hide-value:`` in its :ref:`info-field-lists`. " "Example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:174 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:177 msgid "Doc comments and docstrings" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:176 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:179 msgid "" "Python has no built-in support for docstrings for module data members or " "class attributes. To allow documenting these, ``autodoc`` recognises a " @@ -185,7 +185,7 @@ msgid "" " 'documentation comment'." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:181 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:184 msgid "" "These comments start with a colon and an optional space character, ``'#:'`` " "or ``'#: '``. To be recognised, the comments must appear either on the same " @@ -194,28 +194,28 @@ msgid "" "definition." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:188 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:191 msgid "" "For example, all three of the following variables have valid doc-comments:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:202 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:205 msgid "" "Alternatively, ``autodoc`` can recognise a docstring on the line immediately" " following the definition." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:205 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:208 msgid "" "In the the following class definition, all attributes have documentation " "recognised by ``autodoc``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:233 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:236 msgid "Directives" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:235 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:238 msgid "" ":mod:`autodoc` provides several directives that are versions of the usual " ":rst:dir:`py:module`, :rst:dir:`py:class` and so forth. On parsing time, " @@ -224,24 +224,24 @@ msgid "" ":rst:dir:`py:module`, :rst:dir:`py:class` etc. directive." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:244 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:247 msgid "" "Just as :rst:dir:`py:class` respects the current :rst:dir:`py:module`, " ":rst:dir:`autoclass` will also do so. Likewise, :rst:dir:`automethod` will " "respect the current :rst:dir:`py:class`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:250 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:253 msgid "Default directive options" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:252 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:255 msgid "" "To make any of the options described below the default, use the " ":confval:`autodoc_default_options` dictionary in :file:`conf.py`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:255 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:258 msgid "" "If using defaults for the ``:members:``, ``:exclude-members:``, ``:private-" "members:``, or ``:special-members:`` options, setting the option on a " @@ -250,111 +250,111 @@ msgid "" "(``+``), as follows:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:269 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:272 msgid "" "If using :confval:`autodoc_default_options`, the defaults can be disabled " "per-directive with the negated form, :samp:`:no-{option}:` as an option of " "the directive For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:281 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:284 msgid "Automatically document modules" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:285 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:288 msgid "" "Document a module. By default, the directive only inserts the docstring of " "the module itself:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:292 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:526 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:792 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:866 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:295 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:531 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:797 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:871 msgid "will produce source like this:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:300 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:534 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:303 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:539 msgid "" "The directive can also contain content of its own, which will be inserted " "into the resulting non-auto directive source after the docstring (but before" " any automatic member documentation)." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:304 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:538 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:878 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:307 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:543 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:883 msgid "" "Therefore, you can also mix automatic and non-automatic member " "documentation, as follows:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:317 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:567 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:844 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:894 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:320 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:572 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:849 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:899 msgid "Options" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:321 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:324 msgid "" "Do not generate an index entry for the documented module or any auto-" "documented members." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:329 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:332 msgid "" "Indicate platforms on which the module is available. This is identical to " ":rst:dir:`py:module`'s ``:platform:`` option." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:335 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:338 msgid "" "A sentence describing the module's purpose. This is identical to " ":rst:dir:`py:module`'s ``:synopsis:`` option." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:343 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:346 msgid "" "Mark a module as deprecated. This is identical to :rst:dir:`py:module`'s " "``:deprecated:`` option." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:351 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:354 msgid "Do not use ``__all__`` when analysing the module to document." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:356 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:600 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:359 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:605 msgid "Options for selecting members to document" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:360 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:363 msgid "Generate automatic documentation for all members of the target module:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:367 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:370 msgid "" "By default, ``autodoc`` only includes public members with a docstring or " ":ref:`doc-comment ` (``#:``). If ``__all__`` exists, it will be" -" used to define which members are public, unless the ``:ignore-module-all:``" -" option is set." +" used to define which members are public, unless the :rst:dir:`:ignore-" +"module-all: ` option is set." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:372 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:615 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:376 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:620 msgid "" "To only document certain members, an explicit comma-separated list may be " "used as the argument to ``:members:``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:383 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:626 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:387 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:631 msgid "Exclude the given names from the members to document. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:397 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:401 msgid "" "To prevent documentation of imported classes or functions, in an " ":rst:dir:`!automodule` directive with the ``members`` option set, only " @@ -362,198 +362,197 @@ msgid "" "name given to ``automodule`` will be documented." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:402 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:406 msgid "" "Set the ``imported-members`` option if you want to prevent this behavior and" " document all available members." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:405 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:409 msgid "" "Note that attributes from imported modules will not be documented, because " "attribute documentation is discovered by parsing the source file of the " "current module." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:414 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:418 msgid "" "Generate automatic documentation for members of the target module that don't" " have a docstring or doc-comment. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:427 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:431 msgid "" "Generate automatic documentation for private members of the target module. " "This includes names with a leading underscore (e.g. ``_private``) and those " "members explicitly marked as private with ``:meta private:``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:437 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:703 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:441 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:708 msgid "" "To only document certain private members, an explicit comma-separated list " "may be used as the argument to ``:private-members:``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:447 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:475 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:741 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:451 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:479 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:746 msgid "The option can now take a comma-separated list of arguments." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:453 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:457 msgid "" "Generate automatic documentation for special members of the target module, " -"also known as :ref:`\"dunder\" names `. This includes " -"all names enclosed with a double-underscore, e.g. ``__special__``:" +"also known as :ref:`'dunder' names `. This includes all" +" names enclosed with a double-underscore, e.g. ``__special__``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:464 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:730 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:468 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:735 msgid "" "To only document certain special members, an explicit comma-separated list " "may be used as the argument to ``:special-members:``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:479 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:745 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:483 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:750 msgid "Options for documented members" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:483 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:749 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:487 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:754 msgid "" "Choose the ordering of automatically documented members (default: " "``alphabetical``). This overrides the :confval:`autodoc_member_order` " "setting." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:487 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:491 msgid "``alphabetical``: Use simple alphabetical order." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:489 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:493 msgid "" "``groupwise``: Group by object type (class, function, etc), use alphabetical" " order within groups." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:492 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:496 msgid "" "``bysource``: Use the order of objects in the module's source. The " "``__all__`` variable can be used to override this order." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:496 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:762 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:980 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:500 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:767 msgid "" "Note that for source order, the module must be a Python module with the " "source code available." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:500 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:766 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:504 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:771 msgid "Support the ``'bysource'`` option." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:506 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:510 msgid "" -"Enable the ``:show-inheritance:`` option for all members of the module, if " -"``:members:`` is enabled." +"Enable the :rst:dir:`:show-inheritance: ` option" +" for all members of the module, if ``:members:`` is enabled." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:513 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:518 msgid "Automatically document classes or exceptions" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:518 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:523 msgid "" -"Document a class. For exception classes, prefer ``autoexception``. By " +"Document a class. For exception classes, prefer ``.. autoexception::``. By " "default, the directive only inserts the docstring of the class itself:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:551 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:828 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:556 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:833 msgid "Advanced usage" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:552 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:829 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:557 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:834 msgid "" "It is possible to override the signature for explicitly documented callable " "objects (functions, methods, classes) with the regular syntax that will " "override the signature gained from introspection:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:562 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:839 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:567 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:844 msgid "" "This is useful if the signature from the method is hidden by a decorator." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:571 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:898 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:576 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:903 msgid "" "Do not generate an index entry for the documented class or any auto-" "documented members." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:579 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:584 msgid "" "Select which docstring will be used for the main body of the directive. This" " overrides the global value of :confval:`autoclass_content`. The possible " "values are:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:583 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:588 msgid "" "``class``: Only use the class's docstring. The :meth:`!__init__` method can " "be separately documented using the ``:members:`` option or " ":rst:dir:`automethod`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:587 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:592 msgid "``init``: Only use the docstring of the :meth:`!__init__` method." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:589 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:594 msgid "" -"``both`` Use both, appending the docstring of the :meth:`!__init__` method " +"``both``: Use both, appending the docstring of the :meth:`!__init__` method " "to the class's docstring." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:593 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:598 msgid "" "If the :meth:`!__init__` method doesn't exist or has a blank docstring, " "``autodoc`` will attempt to use the :meth:`!__new__` method's docstring, if " "it exists and is not blank." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:604 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:609 msgid "Generate automatic documentation for all members of the target class:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:611 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:616 msgid "" "By default, ``autodoc`` only includes public members with a docstring or " ":ref:`doc-comment ` (``#:``) that are attributes of the target " "class (i.e. not inherited)." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:640 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:645 msgid "" "To generate automatic documentation for members inherited from base classes," " use the ``:inherited-members:`` option:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:649 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:654 msgid "" "This can be combined with the ``:undoc-members:`` option to generate " "automatic documentation for *all* available members of the class." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:652 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:657 msgid "" "The members of classes listed in the argument to ``:inherited-members:`` are" " excluded from the automatic documentation. This defaults to " @@ -562,105 +561,105 @@ msgid "" "as the argument." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:658 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:663 msgid "" "For example; If your class ``MyList`` is derived from ``list`` class and you" " don't want to document ``list.__len__()``, you should specify a option " "``:inherited-members: list`` to avoid special members of list class." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:664 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:669 msgid "" "Should any of the inherited members use a format other than reStructuredText" " for their docstrings, there may be markup warnings or errors." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:670 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:675 msgid "" "``:inherited-members:`` now takes the name of a base class to exclude as an " "argument." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:674 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:679 msgid "A comma separated list of base class names can be used." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:680 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:685 msgid "" "Generate automatic documentation for members of the target class that don't " "have a docstring or doc-comment. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:693 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:698 msgid "" "Generate automatic documentation for private members of the target class. " "This includes names with a leading underscore (e.g. ``_private``) and those " "members explicitly marked as private with ``:meta private:``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:713 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:718 msgid "The option can now take arguments." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:719 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:724 msgid "" "Generate automatic documentation for special members of the target class, " -"also known as :ref:`\"dunder\" names `. This includes " -"all names enclosed with a double-underscore, e.g. ``__special__``:" +"also known as :ref:`'dunder' names `. This includes all" +" names enclosed with a double-underscore, e.g. ``__special__``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:753 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:758 msgid "``'alphabetical'``: Use simple alphabetical order." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:755 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:760 msgid "" "``'groupwise'``: Group by object type (class, function, etc), use " "alphabetical order within groups." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:758 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:763 msgid "" "``'bysource'``: Use the order of objects in the module's source. The " "``__all__`` variable can be used to override this order." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:772 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:777 msgid "Insert the class's base classes after the class signature." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:778 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:783 msgid "Automatically document function-like objects" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:785 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:790 msgid "" "Document a function, method, property, or decorator. By default, the " "directive only inserts the docstring of the function itself:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:800 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:874 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:805 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:879 msgid "" "The directive can also contain content of its own, which will be inserted " "into the resulting non-auto directive source after the docstring." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:804 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:809 msgid "" "Therefore, you can also mix automatic and non-automatic documentation, as " "follows:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:813 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:818 msgid ":rst:dir:`autodecorator`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:815 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:820 msgid ":rst:dir:`autoproperty`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:820 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:825 msgid "" "If you document decorated functions or methods, keep in mind that " "``autodoc`` retrieves its docstrings by importing the module and inspecting " @@ -669,30 +668,30 @@ msgid "" "the original ``__doc__`` to the new function." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:848 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:853 msgid "Do not generate an index entry for the documented function." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:854 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:859 msgid "Automatically document attributes or data" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:859 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:864 msgid "" "Document a module level variable or constant ('data') or class attribute. By" " default, the directive only inserts the docstring of the variable itself:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:887 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:892 msgid "" ":rst:dir:`autodata` and :rst:dir:`autoattribute` can now extract docstrings." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:890 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:895 msgid "Doc-comments are now allowed on the same line of an assignment." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:908 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:913 msgid "" "By default, ``autodoc`` attempts to obtain the type annotation and value of " "the variable by introspection, displaying it after the variable's name. To " @@ -700,165 +699,225 @@ msgid "" "argument to ``annotation``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:914 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:919 msgid "" "For example, if the runtime value of ``FILE_MODE`` is ``0o755``, the " "displayed value will be ``493`` (as ``oct(493) == '0o755'``). This can be " "fixed by setting ``:annotation: = 0o755``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:918 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:923 msgid "" -"If ``annotation`` is used without arguments, no value or type hint will be " -"shown for the variable." +"If ``:annotation:`` is used without arguments, no value or type hint will be" +" shown for the variable." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:925 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:930 msgid "" -"To display the type hint of the variable without a value, use the ``no-" -"value`` option. If both the ``annotation`` and ``no-value`` options are " -"used, ``no-value`` has no effect." +"To display the type hint of the variable without a value, use the ``:no-" +"value:`` option. If both the ``:annotation:`` and ``:no-value:`` options are" +" used, ``:no-value:`` has no effect." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:932 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:937 msgid "Configuration" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:934 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:939 msgid "There are also config values that you can set:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:938 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:0 +msgid "Type" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:0 +msgid "Default" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:945 msgid "" "This value selects what content will be inserted into the main body of an " ":rst:dir:`autoclass` directive. The possible values are:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:941 -msgid "``\"class\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:948 +msgid "``'class'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:942 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:949 msgid "" -"Only the class' docstring is inserted. This is the default. You can still " -"document ``__init__`` as a separate method using :rst:dir:`automethod` or " -"the ``members`` option to :rst:dir:`autoclass`." +"Only the class' docstring is inserted. You can still document ``__init__`` " +"as a separate method using :rst:dir:`automethod` or the ``members`` option " +"to :rst:dir:`autoclass`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:945 -msgid "``\"both\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:952 +msgid "``'both'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:946 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:953 msgid "" "Both the class' and the ``__init__`` method's docstring are concatenated and" " inserted." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:948 -msgid "``\"init\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:955 +msgid "``'init'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:949 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:956 msgid "Only the ``__init__`` method's docstring is inserted." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:953 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:960 msgid "" "If the class has no ``__init__`` method or if the ``__init__`` method's " "docstring is empty, but the class has a ``__new__`` method's docstring, it " "is used instead." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:961 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:970 msgid "" "This value selects how the signature will be displayed for the class defined" " by :rst:dir:`autoclass` directive. The possible values are:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:964 -msgid "``\"mixed\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:973 +msgid "``'mixed'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:965 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:974 msgid "Display the signature with the class name." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:966 -msgid "``\"separated\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:975 +msgid "``'separated'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:967 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:976 msgid "Display the signature as a method." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:969 -msgid "The default is ``\"mixed\"``." -msgstr "" - -#: ../../sphinx/doc/usage/extensions/autodoc.rst:975 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:984 msgid "" -"This value selects if automatically documented members are sorted " -"alphabetical (value ``'alphabetical'``), by member type (value " -"``'groupwise'``) or by source order (value ``'bysource'``). The default is " -"alphabetical." +"Define the order in which :rst:dir:`automodule` and :rst:dir:`autoclass` " +"members are listed. Supported values are:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:984 -msgid "Support for ``'bysource'``." +#: ../../sphinx/doc/usage/extensions/autodoc.rst:987 +msgid "``'alphabetical'``: Use alphabetical order." msgstr "" #: ../../sphinx/doc/usage/extensions/autodoc.rst:989 +msgid "``'groupwise'``: order by member type. The order is:" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:991 +msgid "for modules, exceptions, classes, functions, data" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:992 +msgid "for classes: methods, then properties and attributes" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:994 +msgid "Members are ordered alphabetically within groups." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:996 msgid "" -"This value is a list of autodoc directive flags that should be automatically" -" applied to all autodoc directives. The supported flags are ``'members'``, " -"``'undoc-members'``, ``'private-members'``, ``'special-members'``, " -"``'inherited-members'``, ``'show-inheritance'``, ``'ignore-module-all'`` and" -" ``'exclude-members'``." +"``'bysource'``: Use the order in which the members appear in the source " +"code. This requires that the module must be a Python module with the source " +"code available." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:999 -msgid "Integrated into :confval:`autodoc_default_options`." +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1002 +msgid "Support for ``'bysource'``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1003 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1009 msgid "" "The default options for autodoc directives. They are applied to all autodoc" " directives automatically. It must be a dictionary which maps option names " "to the values. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1017 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1023 msgid "" "Setting ``None`` or ``True`` to the value is equivalent to giving only the " "option name to the directives." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1020 -msgid "" -"The supported options are ``'members'``, ``'member-order'``, ``'undoc-" -"members'``, ``'private-members'``, ``'special-members'``, ``'inherited-" -"members'``, ``'show-inheritance'``, ``'ignore-module-all'``, ``'imported-" -"members'``, ``'exclude-members'``, ``'class-doc-from'`` and ``'no-value'``." +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1026 +msgid "The supported options are:" msgstr "" #: ../../sphinx/doc/usage/extensions/autodoc.rst:1028 -msgid "Accepts ``True`` as a value." +msgid "``'members'``: See :rst:dir:`automodule:members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1029 +msgid "``'undoc-members'`` See :rst:dir:`automodule:undoc-members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1030 +msgid "``'private-members'``: See :rst:dir:`automodule:private-members`." msgstr "" #: ../../sphinx/doc/usage/extensions/autodoc.rst:1031 -msgid "Added ``'imported-members'``." +msgid "``'special-members'``: See :rst:dir:`automodule:special-members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1032 +msgid "``'inherited-members'``: See :rst:dir:`autoclass:inherited-members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1033 +msgid "``'imported-members'``: See :rst:dir:`automodule:imported-members`." msgstr "" #: ../../sphinx/doc/usage/extensions/autodoc.rst:1034 -msgid "Added ``'class-doc-from'``." +msgid "``'exclude-members'``: See :rst:dir:`automodule:exclude-members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1035 +msgid "``'ignore-module-all'``: See :rst:dir:`automodule:ignore-module-all`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1036 +msgid "``'member-order'``: See :rst:dir:`automodule:member-order`." msgstr "" #: ../../sphinx/doc/usage/extensions/autodoc.rst:1037 +msgid "``'show-inheritance'``: See :rst:dir:`autoclass:show-inheritance`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1038 +msgid "``'class-doc-from'``: See :rst:dir:`autoclass:class-doc-from`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1039 +msgid "``'no-value'``: See :rst:dir:`autodata:no-value`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1043 +msgid "Accepts ``True`` as a value." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1046 +msgid "Added ``'imported-members'``." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1049 +msgid "Added ``'class-doc-from'``." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1052 msgid "Added ``'no-value'``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1042 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1059 msgid "" "Functions imported from C modules cannot be introspected, and therefore the " "signature for such functions cannot be automatically determined. However, " @@ -866,7 +925,7 @@ msgid "" "the function's docstring." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1047 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1064 msgid "" "If this boolean value is set to ``True`` (which is the default), autodoc " "will look at the first line of the docstring for functions and methods, and " @@ -874,22 +933,22 @@ msgid "" "from the docstring content." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1052 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1069 msgid "" "autodoc will continue to look for multiple signature lines, stopping at the " "first line that does not look like a signature. This is useful for declaring" " overloaded function signatures." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1059 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1076 msgid "Support overloaded signatures" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1063 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1080 msgid "Overloaded signatures do not need to be separated by a backslash" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1067 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1086 msgid "" "This value contains a list of modules to be mocked up. This is useful when " "some external dependencies are not met at build time and break the building " @@ -897,198 +956,194 @@ msgid "" "themselves and omit the sub-modules:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1076 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1095 msgid "Will mock all imports under the ``django`` package." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1080 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1099 msgid "" "This config value only requires to declare the top-level modules that should" " be mocked." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1086 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1107 msgid "" "This value controls how to represent typehints. The setting takes the " "following values:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1089 -msgid "``'signature'`` -- Show typehints in the signature (default)" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1110 +msgid "``'signature'`` -- Show typehints in the signature" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1090 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1111 msgid "" "``'description'`` -- Show typehints as content of the function or method The" " typehints of overloaded functions or methods will still be represented in " "the signature." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1093 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1114 msgid "``'none'`` -- Do not show typehints" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1094 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1115 msgid "" "``'both'`` -- Show typehints in the signature and as content of the function" " or method" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1097 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1118 msgid "" "Overloaded functions or methods will not have typehints included in the " "description because it is impossible to accurately represent all possible " "overloads as a list of parameters." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1104 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1125 msgid "New option ``'description'`` is added." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1108 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1129 msgid "New option ``'both'`` is added." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1112 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1135 msgid "" "This value controls whether the types of undocumented parameters and return " -"values are documented when ``autodoc_typehints`` is set to ``description``." +"values are documented when :confval:`autodoc_typehints` is set to " +"``'description'``. Supported values:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1115 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1140 msgid "" -"The default value is ``\"all\"``, meaning that types are documented for all " -"parameters and return values, whether they are documented or not." +"``'all'``: Types are documented for all parameters and return values, " +"whether they are documented or not." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1118 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1143 msgid "" -"When set to ``\"documented\"``, types will only be documented for a " -"parameter or a return value that is already documented by the docstring." +"``'documented'``: Types will only be documented for a parameter or a return " +"value that is already documented by the docstring." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1121 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1146 msgid "" -"With ``\"documented_params\"``, parameter types will only be annotated if " -"the parameter is documented in the docstring. The return type is always " +"``'documented_params'``: Parameter types will only be annotated if the " +"parameter is documented in the docstring. The return type is always " "annotated (except if it is ``None``)." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1129 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1155 msgid "New option ``'documented_params'`` is added." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1133 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1161 msgid "" "A dictionary for users defined `type aliases`__ that maps a type name to the" " full-qualified object name. It is used to keep type aliases not evaluated " -"in the document. Defaults to empty (``{}``)." +"in the document." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1137 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1165 msgid "" "The type aliases are only available if your program enables :pep:`Postponed " "Evaluation of Annotations (PEP 563) <563>` feature via ``from __future__ " "import annotations``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1141 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1169 msgid "For example, there is code using a type alias:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1152 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1180 msgid "" "If ``autodoc_type_aliases`` is not set, autodoc will generate internal mark-" "up from this code as following:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1161 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1189 msgid "" "If you set ``autodoc_type_aliases`` as ``{'AliasType': " "'your.module.AliasType'}``, it generates the following document internally:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1176 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1206 msgid "" "This value controls the format of typehints. The setting takes the " "following values:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1179 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1209 msgid "" "``'fully-qualified'`` -- Show the module name and its name of typehints" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1180 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1210 msgid "" "``'short'`` -- Suppress the leading module names of the typehints (e.g. " -"``io.StringIO`` -> ``StringIO``) (default)" +"``io.StringIO`` -> ``StringIO``)" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1187 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1217 msgid "The default setting was changed to ``'short'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1191 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1223 msgid "" "If True, the default argument values of functions will be not evaluated on " "generating document. It preserves them as is in the source code." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1196 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1228 msgid "" "Added as an experimental feature. This will be integrated into autodoc core" " in the future." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1201 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1235 msgid "" "This value controls the behavior of :option:`sphinx-build --fail-on-warning`" " during importing modules. If ``False`` is given, autodoc forcedly " -"suppresses the error if the imported module emits warnings. By default, " -"``True``." +"suppresses the error if the imported module emits warnings." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1206 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1240 msgid "" "This option now has no effect as :option:`!--fail-on-warning` no longer " "exits early." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1212 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1248 msgid "" "This value controls the docstrings inheritance. If set to True the docstring" " for classes or methods, if not explicitly set, is inherited from parents." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1216 -msgid "The default is ``True``." -msgstr "" - -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1223 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1259 msgid "" -":mod:`autodoc` supports to suppress warning messages via " -":confval:`suppress_warnings`. It allows following warnings types in " -"addition:" +":mod:`autodoc` supports suppressing warning messages via " +":confval:`suppress_warnings`. It defines the following additional warnings " +"types:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1227 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1263 msgid "autodoc" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1228 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1264 msgid "autodoc.import_object" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1232 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1268 msgid "Docstring preprocessing" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1234 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1270 msgid "autodoc provides the following additional events:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1240 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1276 msgid "" "Emitted when autodoc has read and processed a docstring. *lines* is a list " "of strings -- the lines of the processed docstring -- that the event handler" @@ -1099,41 +1154,40 @@ msgstr "" msgid "Parameters" msgstr "Parameter" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1244 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1263 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1275 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1304 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1336 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1280 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1299 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1311 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1340 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1372 msgid "the Sphinx application object" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1245 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1276 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1337 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1281 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1312 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1373 msgid "" -"the type of the object which the docstring belongs to (one of " -"``\"module\"``, ``\"class\"``, ``\"exception\"``, ``\"function\"``, " -"``\"method\"``, ``\"attribute\"``)" +"the type of the object which the docstring belongs to (one of ``'module'``, " +"``'class'``, ``'exception'``, ``'function'``, ``'method'``, ``'attribute'``)" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1248 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1279 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1305 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1340 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1284 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1315 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1341 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1376 msgid "the fully qualified name of the object" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1249 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1264 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1280 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1306 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1341 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1285 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1300 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1316 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1342 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1377 msgid "the object itself" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1250 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1281 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1344 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1286 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1317 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1380 msgid "" "the options given to the directive: an object with attributes " "``inherited_members``, ``undoc_members``, ``show_inheritance`` and ``no-" @@ -1141,41 +1195,41 @@ msgid "" "directive" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1254 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1290 msgid "the lines of the docstring, see above" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1260 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1296 msgid "" "Emitted before autodoc formats a signature for an object. The event handler " "can modify an object to change its signature." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1265 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1301 msgid "a boolean indicates an object is bound method or not" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1271 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1307 msgid "" "Emitted when autodoc has formatted a signature for an object. The event " "handler can return a new tuple ``(signature, return_annotation)`` to change " "what Sphinx puts into the output." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1285 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1321 msgid "" -"function signature, as a string of the form ``\"(parameter_1, " -"parameter_2)\"``, or ``None`` if introspection didn't succeed and signature " +"function signature, as a string of the form ``'(parameter_1, " +"parameter_2)'``, or ``None`` if introspection didn't succeed and signature " "wasn't specified in the directive." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1288 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1324 msgid "" -"function return annotation as a string of the form ``\" -> annotation\"``, " -"or ``None`` if there is no return annotation" +"function return annotation as a string of the form ``' -> annotation'``, or " +"``None`` if there is no return annotation" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1291 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1327 msgid "" "The :mod:`sphinx.ext.autodoc` module provides factory functions for commonly" " needed docstring processing in event :event:`autodoc-process-docstring`:" @@ -1216,7 +1270,7 @@ msgid "" " be processed." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1299 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1335 msgid "" "Emitted when autodoc has read and processed a class to determine the base-" "classes. *bases* is a list of classes that the event handler can modify " @@ -1224,38 +1278,38 @@ msgid "" "if ``show-inheritance`` option given." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1307 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1343 msgid "the options given to the class directive" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1308 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1344 msgid "the list of base classes signature. see above." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1313 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1349 msgid "" "``bases`` can contain a string as a base class name. It will be processed as" " reStructuredText." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1318 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1354 msgid "Skipping members" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1320 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1356 msgid "" "autodoc allows the user to define a custom method for determining whether a " "member should be included in the documentation by using the following event:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1327 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1363 msgid "" "Emitted when autodoc has to decide whether a member should be included in " "the documentation. The member is excluded if a handler returns ``True``. " "It is included if the handler returns ``False``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1331 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1367 msgid "" "If more than one enabled extension handles the ``autodoc-skip-member`` " "event, autodoc will use the first non-``None`` value returned by a handler. " @@ -1263,7 +1317,7 @@ msgid "" "autodoc and other enabled extensions." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1342 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1378 msgid "" "a boolean indicating if autodoc will skip this member if the user handler " "does not override the decision" diff --git a/locale/es/LC_MESSAGES/changes/1.8.po b/locale/es/LC_MESSAGES/changes/1.8.po index 244722dfe0..eb2d957778 100644 --- a/locale/es/LC_MESSAGES/changes/1.8.po +++ b/locale/es/LC_MESSAGES/changes/1.8.po @@ -11,7 +11,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-10-01 00:54+0000\n" +"POT-Creation-Date: 2024-10-03 00:49+0000\n" "PO-Revision-Date: 2024-07-31 00:36+0000\n" "Last-Translator: Takayuki SHIMIZUKAWA , 2024\n" "Language-Team: Spanish (https://app.transifex.com/sphinx-doc/teams/15434/es/)\n" @@ -400,7 +400,7 @@ msgstr "" #: ../../sphinx/doc/changes/1.8.rst:150 msgid "" "#5421: autodoc emits deprecation warning for " -":confval:`autodoc_default_flags`" +":confval:`!autodoc_default_flags`" msgstr "" #: ../../sphinx/doc/changes/1.8.rst:151 @@ -668,7 +668,7 @@ msgid ":confval:`!source_parsers` is deprecated" msgstr "" #: ../../sphinx/doc/changes/1.8.rst:254 -msgid ":confval:`autodoc_default_flags` is deprecated" +msgid ":confval:`!autodoc_default_flags` is deprecated" msgstr "" #: ../../sphinx/doc/changes/1.8.rst:255 diff --git a/locale/es/LC_MESSAGES/changes/index.po b/locale/es/LC_MESSAGES/changes/index.po index 7ac5674cfc..21e277c6f8 100644 --- a/locale/es/LC_MESSAGES/changes/index.po +++ b/locale/es/LC_MESSAGES/changes/index.po @@ -11,7 +11,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-09-28 00:48+0000\n" +"POT-Creation-Date: 2024-10-03 00:49+0000\n" "PO-Revision-Date: 2024-07-31 00:36+0000\n" "Last-Translator: Takayuki SHIMIZUKAWA , 2024\n" "Language-Team: Spanish (https://app.transifex.com/sphinx-doc/teams/15434/es/)\n" @@ -238,11 +238,18 @@ msgid "" ":rst:dir:`py:module` directives. Patch by Stephen Finucane." msgstr "" -#: ../../sphinx/CHANGES.rst:112 +#: ../../sphinx/CHANGES.rst:110 +msgid "" +"#12916: Restore support for custom templates named with the legacy ``_t`` " +"suffix during ``apidoc`` RST rendering (regression in 7.4.0). Patch by James" +" Addison." +msgstr "" + +#: ../../sphinx/CHANGES.rst:115 msgid "Testing" msgstr "" -#: ../../sphinx/CHANGES.rst:114 +#: ../../sphinx/CHANGES.rst:117 msgid "" "#12141: Migrate from the deprecated ``karma`` JavaScript test framework to " "the actively-maintained ``jasmine`` framework. Test coverage is unaffected." diff --git a/locale/es/LC_MESSAGES/extdev/deprecated.po b/locale/es/LC_MESSAGES/extdev/deprecated.po index 65ff96d982..d90bbb1351 100644 --- a/locale/es/LC_MESSAGES/extdev/deprecated.po +++ b/locale/es/LC_MESSAGES/extdev/deprecated.po @@ -11,7 +11,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-09-02 00:47+0000\n" +"POT-Creation-Date: 2024-10-03 00:50+0000\n" "PO-Revision-Date: 2019-03-09 18:04+0000\n" "Last-Translator: Takayuki SHIMIZUKAWA , 2021\n" "Language-Team: Spanish (https://app.transifex.com/sphinx-doc/teams/15434/es/)\n" @@ -2852,7 +2852,7 @@ msgid ":meth:`~sphinx.application.Sphinx.add_js_file`" msgstr "" #: ../../sphinx/doc/extdev/deprecated.rst:1457 -msgid ":confval:`autodoc_default_flags`" +msgid ":confval:`!autodoc_default_flags`" msgstr "" #: ../../sphinx/doc/extdev/deprecated.rst:1460 diff --git a/locale/es/LC_MESSAGES/usage/domains/restructuredtext.po b/locale/es/LC_MESSAGES/usage/domains/restructuredtext.po index e5e3ae0006..922ba7036a 100644 --- a/locale/es/LC_MESSAGES/usage/domains/restructuredtext.po +++ b/locale/es/LC_MESSAGES/usage/domains/restructuredtext.po @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-09-15 00:53+0000\n" +"POT-Creation-Date: 2024-10-03 00:49+0000\n" "PO-Revision-Date: 2023-10-03 00:37+0000\n" "Language-Team: Spanish (https://app.transifex.com/sphinx-doc/teams/15434/es/)\n" "MIME-Version: 1.0\n" @@ -75,3 +75,20 @@ msgstr "" #: ../../sphinx/doc/usage/domains/restructuredtext.rst:97 msgid "These roles are provided to refer to the described objects:" msgstr "" + +#: ../../sphinx/doc/usage/domains/restructuredtext.rst:101 +msgid "Reference directives and directive options. Examples:" +msgstr "" + +#: ../../sphinx/doc/usage/domains/restructuredtext.rst:103 +msgid "Use ``:rst:dir:`my-directive``` to reference a directive." +msgstr "" + +#: ../../sphinx/doc/usage/domains/restructuredtext.rst:104 +msgid "" +"Use ``:rst:dir:`my-directive:my-option``` to reference a directive option." +msgstr "" + +#: ../../sphinx/doc/usage/domains/restructuredtext.rst:109 +msgid "Reference a role. Example: ``:rst:role:`my-role```." +msgstr "" diff --git a/locale/es/LC_MESSAGES/usage/extensions/autodoc.po b/locale/es/LC_MESSAGES/usage/extensions/autodoc.po index aa365dc8e2..3a476f03ac 100644 --- a/locale/es/LC_MESSAGES/usage/extensions/autodoc.po +++ b/locale/es/LC_MESSAGES/usage/extensions/autodoc.po @@ -12,7 +12,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-10-02 00:49+0000\n" +"POT-Creation-Date: 2024-10-03 00:50+0000\n" "PO-Revision-Date: 2018-06-26 15:58+0000\n" "Last-Translator: Takayuki SHIMIZUKAWA , 2024\n" "Language-Team: Spanish (https://app.transifex.com/sphinx-doc/teams/15434/es/)\n" @@ -26,26 +26,26 @@ msgstr "" msgid ":mod:`sphinx.ext.autodoc` -- Include documentation from docstrings" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:12 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:15 msgid "" "This extension can import the modules you are documenting, and pull in " "documentation from docstrings in a semi-automatic way." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:17 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:20 msgid "" ":mod:`~sphinx.ext.autodoc` **imports** the modules to be documented. If any " "modules have side effects on import, these will be executed by ``autodoc`` " "when :program:`sphinx-build` is run." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:21 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:24 msgid "" "If you document scripts (as opposed to library modules), make sure that the " "main routine is protected by an ``if __name__ == '__main__'`` condition." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:25 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:28 msgid "" "For this to work, the docstrings must of course be written in correct " "reStructuredText. You can then use all of the usual Sphinx markup in the " @@ -55,7 +55,7 @@ msgid "" "auto-generated-looking pure API documentation." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:33 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:36 msgid "" "If you prefer `NumPy`_ or `Google`_ style docstrings over reStructuredText, " "you can also enable the :mod:`napoleon ` extension. " @@ -63,25 +63,25 @@ msgid "" "reStructuredText before ``autodoc`` processes them." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:43 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:46 msgid "Getting started" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:47 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:50 msgid "Setup" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:49 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:52 msgid "" "Activate the plugin by adding ``'sphinx.ext.autodoc'`` to the " ":confval:`extensions` list in :file:`conf.py`:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:61 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:64 msgid "Ensuring the code can be imported" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:63 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:66 msgid "" ":mod:`~sphinx.ext.autodoc` analyses the code and docstrings by introspection" " after **importing the modules**. For importing to work, you have to make " @@ -91,11 +91,11 @@ msgid "" "fail)." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:70 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:73 msgid "There are two ways to ensure this:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:72 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:75 msgid "" "Use an environment that contains your package and Sphinx. This can e.g. be " "your local development environment (with an editable install), or an " @@ -104,14 +104,14 @@ msgid "" "that all dependencies are available." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:78 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:81 msgid "" "It is alternatively possible to patch the Sphinx run so that it can operate " "directly on the sources; e.g. if you want to be able to do a Sphinx build " "from a source checkout." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:82 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:85 msgid "" "Patch :data:`sys.path` in :file:`conf.py` to include your source path. For " "example if you have a repository structure with :file:`doc/conf.py` and your" @@ -119,17 +119,17 @@ msgid "" "your :file:`conf.py`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:94 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:97 msgid "" "To cope with missing dependencies, specify the missing modules in the " ":confval:`autodoc_mock_imports` setting." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:99 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:102 msgid "Usage" msgstr "Uso" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:101 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:104 msgid "" "You can now use the :ref:`autodoc-directives` to add formatted documentation" " for Python code elements like functions, classes, modules, etc. For " @@ -137,48 +137,48 @@ msgid "" "docstring from the source file, you'd write:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:110 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:113 msgid "" "You can also document whole classes or even modules automatically, using " "member options for the auto directives, like:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:119 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:122 msgid "" "As a hint to autodoc extension, you can put a ``::`` separator between the " "module name and the object name to let autodoc know the correct module, if " "it is ambiguous:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:129 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:132 msgid "Marking objects as public or private" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:131 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:134 msgid "" "autodoc considers a member private if its docstring contains ``:meta " "private:`` in its :ref:`info-field-lists`. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:145 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:148 msgid "" "autodoc considers a member public if its docstring contains ``:meta " "public:`` in its :ref:`info-field-lists`, even if it starts with an " "underscore. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:160 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:163 msgid "" "autodoc considers a variable member does not have any default value if its " "docstring contains ``:meta hide-value:`` in its :ref:`info-field-lists`. " "Example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:174 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:177 msgid "Doc comments and docstrings" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:176 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:179 msgid "" "Python has no built-in support for docstrings for module data members or " "class attributes. To allow documenting these, ``autodoc`` recognises a " @@ -186,7 +186,7 @@ msgid "" " 'documentation comment'." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:181 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:184 msgid "" "These comments start with a colon and an optional space character, ``'#:'`` " "or ``'#: '``. To be recognised, the comments must appear either on the same " @@ -195,28 +195,28 @@ msgid "" "definition." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:188 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:191 msgid "" "For example, all three of the following variables have valid doc-comments:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:202 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:205 msgid "" "Alternatively, ``autodoc`` can recognise a docstring on the line immediately" " following the definition." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:205 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:208 msgid "" "In the the following class definition, all attributes have documentation " "recognised by ``autodoc``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:233 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:236 msgid "Directives" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:235 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:238 msgid "" ":mod:`autodoc` provides several directives that are versions of the usual " ":rst:dir:`py:module`, :rst:dir:`py:class` and so forth. On parsing time, " @@ -225,24 +225,24 @@ msgid "" ":rst:dir:`py:module`, :rst:dir:`py:class` etc. directive." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:244 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:247 msgid "" "Just as :rst:dir:`py:class` respects the current :rst:dir:`py:module`, " ":rst:dir:`autoclass` will also do so. Likewise, :rst:dir:`automethod` will " "respect the current :rst:dir:`py:class`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:250 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:253 msgid "Default directive options" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:252 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:255 msgid "" "To make any of the options described below the default, use the " ":confval:`autodoc_default_options` dictionary in :file:`conf.py`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:255 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:258 msgid "" "If using defaults for the ``:members:``, ``:exclude-members:``, ``:private-" "members:``, or ``:special-members:`` options, setting the option on a " @@ -251,111 +251,111 @@ msgid "" "(``+``), as follows:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:269 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:272 msgid "" "If using :confval:`autodoc_default_options`, the defaults can be disabled " "per-directive with the negated form, :samp:`:no-{option}:` as an option of " "the directive For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:281 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:284 msgid "Automatically document modules" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:285 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:288 msgid "" "Document a module. By default, the directive only inserts the docstring of " "the module itself:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:292 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:526 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:792 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:866 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:295 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:531 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:797 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:871 msgid "will produce source like this:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:300 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:534 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:303 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:539 msgid "" "The directive can also contain content of its own, which will be inserted " "into the resulting non-auto directive source after the docstring (but before" " any automatic member documentation)." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:304 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:538 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:878 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:307 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:543 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:883 msgid "" "Therefore, you can also mix automatic and non-automatic member " "documentation, as follows:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:317 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:567 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:844 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:894 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:320 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:572 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:849 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:899 msgid "Options" msgstr "Opciones" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:321 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:324 msgid "" "Do not generate an index entry for the documented module or any auto-" "documented members." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:329 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:332 msgid "" "Indicate platforms on which the module is available. This is identical to " ":rst:dir:`py:module`'s ``:platform:`` option." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:335 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:338 msgid "" "A sentence describing the module's purpose. This is identical to " ":rst:dir:`py:module`'s ``:synopsis:`` option." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:343 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:346 msgid "" "Mark a module as deprecated. This is identical to :rst:dir:`py:module`'s " "``:deprecated:`` option." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:351 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:354 msgid "Do not use ``__all__`` when analysing the module to document." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:356 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:600 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:359 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:605 msgid "Options for selecting members to document" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:360 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:363 msgid "Generate automatic documentation for all members of the target module:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:367 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:370 msgid "" "By default, ``autodoc`` only includes public members with a docstring or " ":ref:`doc-comment ` (``#:``). If ``__all__`` exists, it will be" -" used to define which members are public, unless the ``:ignore-module-all:``" -" option is set." +" used to define which members are public, unless the :rst:dir:`:ignore-" +"module-all: ` option is set." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:372 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:615 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:376 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:620 msgid "" "To only document certain members, an explicit comma-separated list may be " "used as the argument to ``:members:``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:383 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:626 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:387 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:631 msgid "Exclude the given names from the members to document. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:397 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:401 msgid "" "To prevent documentation of imported classes or functions, in an " ":rst:dir:`!automodule` directive with the ``members`` option set, only " @@ -363,198 +363,197 @@ msgid "" "name given to ``automodule`` will be documented." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:402 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:406 msgid "" "Set the ``imported-members`` option if you want to prevent this behavior and" " document all available members." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:405 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:409 msgid "" "Note that attributes from imported modules will not be documented, because " "attribute documentation is discovered by parsing the source file of the " "current module." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:414 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:418 msgid "" "Generate automatic documentation for members of the target module that don't" " have a docstring or doc-comment. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:427 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:431 msgid "" "Generate automatic documentation for private members of the target module. " "This includes names with a leading underscore (e.g. ``_private``) and those " "members explicitly marked as private with ``:meta private:``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:437 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:703 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:441 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:708 msgid "" "To only document certain private members, an explicit comma-separated list " "may be used as the argument to ``:private-members:``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:447 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:475 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:741 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:451 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:479 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:746 msgid "The option can now take a comma-separated list of arguments." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:453 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:457 msgid "" "Generate automatic documentation for special members of the target module, " -"also known as :ref:`\"dunder\" names `. This includes " -"all names enclosed with a double-underscore, e.g. ``__special__``:" +"also known as :ref:`'dunder' names `. This includes all" +" names enclosed with a double-underscore, e.g. ``__special__``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:464 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:730 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:468 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:735 msgid "" "To only document certain special members, an explicit comma-separated list " "may be used as the argument to ``:special-members:``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:479 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:745 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:483 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:750 msgid "Options for documented members" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:483 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:749 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:487 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:754 msgid "" "Choose the ordering of automatically documented members (default: " "``alphabetical``). This overrides the :confval:`autodoc_member_order` " "setting." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:487 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:491 msgid "``alphabetical``: Use simple alphabetical order." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:489 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:493 msgid "" "``groupwise``: Group by object type (class, function, etc), use alphabetical" " order within groups." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:492 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:496 msgid "" "``bysource``: Use the order of objects in the module's source. The " "``__all__`` variable can be used to override this order." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:496 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:762 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:980 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:500 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:767 msgid "" "Note that for source order, the module must be a Python module with the " "source code available." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:500 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:766 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:504 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:771 msgid "Support the ``'bysource'`` option." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:506 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:510 msgid "" -"Enable the ``:show-inheritance:`` option for all members of the module, if " -"``:members:`` is enabled." +"Enable the :rst:dir:`:show-inheritance: ` option" +" for all members of the module, if ``:members:`` is enabled." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:513 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:518 msgid "Automatically document classes or exceptions" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:518 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:523 msgid "" -"Document a class. For exception classes, prefer ``autoexception``. By " +"Document a class. For exception classes, prefer ``.. autoexception::``. By " "default, the directive only inserts the docstring of the class itself:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:551 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:828 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:556 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:833 msgid "Advanced usage" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:552 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:829 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:557 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:834 msgid "" "It is possible to override the signature for explicitly documented callable " "objects (functions, methods, classes) with the regular syntax that will " "override the signature gained from introspection:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:562 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:839 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:567 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:844 msgid "" "This is useful if the signature from the method is hidden by a decorator." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:571 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:898 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:576 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:903 msgid "" "Do not generate an index entry for the documented class or any auto-" "documented members." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:579 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:584 msgid "" "Select which docstring will be used for the main body of the directive. This" " overrides the global value of :confval:`autoclass_content`. The possible " "values are:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:583 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:588 msgid "" "``class``: Only use the class's docstring. The :meth:`!__init__` method can " "be separately documented using the ``:members:`` option or " ":rst:dir:`automethod`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:587 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:592 msgid "``init``: Only use the docstring of the :meth:`!__init__` method." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:589 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:594 msgid "" -"``both`` Use both, appending the docstring of the :meth:`!__init__` method " +"``both``: Use both, appending the docstring of the :meth:`!__init__` method " "to the class's docstring." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:593 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:598 msgid "" "If the :meth:`!__init__` method doesn't exist or has a blank docstring, " "``autodoc`` will attempt to use the :meth:`!__new__` method's docstring, if " "it exists and is not blank." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:604 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:609 msgid "Generate automatic documentation for all members of the target class:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:611 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:616 msgid "" "By default, ``autodoc`` only includes public members with a docstring or " ":ref:`doc-comment ` (``#:``) that are attributes of the target " "class (i.e. not inherited)." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:640 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:645 msgid "" "To generate automatic documentation for members inherited from base classes," " use the ``:inherited-members:`` option:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:649 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:654 msgid "" "This can be combined with the ``:undoc-members:`` option to generate " "automatic documentation for *all* available members of the class." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:652 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:657 msgid "" "The members of classes listed in the argument to ``:inherited-members:`` are" " excluded from the automatic documentation. This defaults to " @@ -563,105 +562,105 @@ msgid "" "as the argument." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:658 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:663 msgid "" "For example; If your class ``MyList`` is derived from ``list`` class and you" " don't want to document ``list.__len__()``, you should specify a option " "``:inherited-members: list`` to avoid special members of list class." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:664 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:669 msgid "" "Should any of the inherited members use a format other than reStructuredText" " for their docstrings, there may be markup warnings or errors." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:670 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:675 msgid "" "``:inherited-members:`` now takes the name of a base class to exclude as an " "argument." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:674 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:679 msgid "A comma separated list of base class names can be used." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:680 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:685 msgid "" "Generate automatic documentation for members of the target class that don't " "have a docstring or doc-comment. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:693 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:698 msgid "" "Generate automatic documentation for private members of the target class. " "This includes names with a leading underscore (e.g. ``_private``) and those " "members explicitly marked as private with ``:meta private:``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:713 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:718 msgid "The option can now take arguments." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:719 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:724 msgid "" "Generate automatic documentation for special members of the target class, " -"also known as :ref:`\"dunder\" names `. This includes " -"all names enclosed with a double-underscore, e.g. ``__special__``:" +"also known as :ref:`'dunder' names `. This includes all" +" names enclosed with a double-underscore, e.g. ``__special__``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:753 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:758 msgid "``'alphabetical'``: Use simple alphabetical order." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:755 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:760 msgid "" "``'groupwise'``: Group by object type (class, function, etc), use " "alphabetical order within groups." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:758 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:763 msgid "" "``'bysource'``: Use the order of objects in the module's source. The " "``__all__`` variable can be used to override this order." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:772 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:777 msgid "Insert the class's base classes after the class signature." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:778 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:783 msgid "Automatically document function-like objects" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:785 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:790 msgid "" "Document a function, method, property, or decorator. By default, the " "directive only inserts the docstring of the function itself:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:800 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:874 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:805 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:879 msgid "" "The directive can also contain content of its own, which will be inserted " "into the resulting non-auto directive source after the docstring." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:804 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:809 msgid "" "Therefore, you can also mix automatic and non-automatic documentation, as " "follows:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:813 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:818 msgid ":rst:dir:`autodecorator`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:815 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:820 msgid ":rst:dir:`autoproperty`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:820 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:825 msgid "" "If you document decorated functions or methods, keep in mind that " "``autodoc`` retrieves its docstrings by importing the module and inspecting " @@ -670,30 +669,30 @@ msgid "" "the original ``__doc__`` to the new function." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:848 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:853 msgid "Do not generate an index entry for the documented function." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:854 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:859 msgid "Automatically document attributes or data" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:859 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:864 msgid "" "Document a module level variable or constant ('data') or class attribute. By" " default, the directive only inserts the docstring of the variable itself:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:887 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:892 msgid "" ":rst:dir:`autodata` and :rst:dir:`autoattribute` can now extract docstrings." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:890 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:895 msgid "Doc-comments are now allowed on the same line of an assignment." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:908 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:913 msgid "" "By default, ``autodoc`` attempts to obtain the type annotation and value of " "the variable by introspection, displaying it after the variable's name. To " @@ -701,165 +700,225 @@ msgid "" "argument to ``annotation``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:914 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:919 msgid "" "For example, if the runtime value of ``FILE_MODE`` is ``0o755``, the " "displayed value will be ``493`` (as ``oct(493) == '0o755'``). This can be " "fixed by setting ``:annotation: = 0o755``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:918 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:923 msgid "" -"If ``annotation`` is used without arguments, no value or type hint will be " -"shown for the variable." +"If ``:annotation:`` is used without arguments, no value or type hint will be" +" shown for the variable." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:925 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:930 msgid "" -"To display the type hint of the variable without a value, use the ``no-" -"value`` option. If both the ``annotation`` and ``no-value`` options are " -"used, ``no-value`` has no effect." +"To display the type hint of the variable without a value, use the ``:no-" +"value:`` option. If both the ``:annotation:`` and ``:no-value:`` options are" +" used, ``:no-value:`` has no effect." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:932 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:937 msgid "Configuration" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:934 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:939 msgid "There are also config values that you can set:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:938 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:0 +msgid "Type" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:0 +msgid "Default" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:945 msgid "" "This value selects what content will be inserted into the main body of an " ":rst:dir:`autoclass` directive. The possible values are:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:941 -msgid "``\"class\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:948 +msgid "``'class'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:942 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:949 msgid "" -"Only the class' docstring is inserted. This is the default. You can still " -"document ``__init__`` as a separate method using :rst:dir:`automethod` or " -"the ``members`` option to :rst:dir:`autoclass`." +"Only the class' docstring is inserted. You can still document ``__init__`` " +"as a separate method using :rst:dir:`automethod` or the ``members`` option " +"to :rst:dir:`autoclass`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:945 -msgid "``\"both\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:952 +msgid "``'both'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:946 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:953 msgid "" "Both the class' and the ``__init__`` method's docstring are concatenated and" " inserted." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:948 -msgid "``\"init\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:955 +msgid "``'init'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:949 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:956 msgid "Only the ``__init__`` method's docstring is inserted." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:953 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:960 msgid "" "If the class has no ``__init__`` method or if the ``__init__`` method's " "docstring is empty, but the class has a ``__new__`` method's docstring, it " "is used instead." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:961 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:970 msgid "" "This value selects how the signature will be displayed for the class defined" " by :rst:dir:`autoclass` directive. The possible values are:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:964 -msgid "``\"mixed\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:973 +msgid "``'mixed'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:965 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:974 msgid "Display the signature with the class name." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:966 -msgid "``\"separated\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:975 +msgid "``'separated'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:967 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:976 msgid "Display the signature as a method." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:969 -msgid "The default is ``\"mixed\"``." -msgstr "" - -#: ../../sphinx/doc/usage/extensions/autodoc.rst:975 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:984 msgid "" -"This value selects if automatically documented members are sorted " -"alphabetical (value ``'alphabetical'``), by member type (value " -"``'groupwise'``) or by source order (value ``'bysource'``). The default is " -"alphabetical." +"Define the order in which :rst:dir:`automodule` and :rst:dir:`autoclass` " +"members are listed. Supported values are:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:984 -msgid "Support for ``'bysource'``." +#: ../../sphinx/doc/usage/extensions/autodoc.rst:987 +msgid "``'alphabetical'``: Use alphabetical order." msgstr "" #: ../../sphinx/doc/usage/extensions/autodoc.rst:989 +msgid "``'groupwise'``: order by member type. The order is:" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:991 +msgid "for modules, exceptions, classes, functions, data" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:992 +msgid "for classes: methods, then properties and attributes" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:994 +msgid "Members are ordered alphabetically within groups." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:996 msgid "" -"This value is a list of autodoc directive flags that should be automatically" -" applied to all autodoc directives. The supported flags are ``'members'``, " -"``'undoc-members'``, ``'private-members'``, ``'special-members'``, " -"``'inherited-members'``, ``'show-inheritance'``, ``'ignore-module-all'`` and" -" ``'exclude-members'``." +"``'bysource'``: Use the order in which the members appear in the source " +"code. This requires that the module must be a Python module with the source " +"code available." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:999 -msgid "Integrated into :confval:`autodoc_default_options`." +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1002 +msgid "Support for ``'bysource'``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1003 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1009 msgid "" "The default options for autodoc directives. They are applied to all autodoc" " directives automatically. It must be a dictionary which maps option names " "to the values. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1017 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1023 msgid "" "Setting ``None`` or ``True`` to the value is equivalent to giving only the " "option name to the directives." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1020 -msgid "" -"The supported options are ``'members'``, ``'member-order'``, ``'undoc-" -"members'``, ``'private-members'``, ``'special-members'``, ``'inherited-" -"members'``, ``'show-inheritance'``, ``'ignore-module-all'``, ``'imported-" -"members'``, ``'exclude-members'``, ``'class-doc-from'`` and ``'no-value'``." +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1026 +msgid "The supported options are:" msgstr "" #: ../../sphinx/doc/usage/extensions/autodoc.rst:1028 -msgid "Accepts ``True`` as a value." +msgid "``'members'``: See :rst:dir:`automodule:members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1029 +msgid "``'undoc-members'`` See :rst:dir:`automodule:undoc-members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1030 +msgid "``'private-members'``: See :rst:dir:`automodule:private-members`." msgstr "" #: ../../sphinx/doc/usage/extensions/autodoc.rst:1031 -msgid "Added ``'imported-members'``." +msgid "``'special-members'``: See :rst:dir:`automodule:special-members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1032 +msgid "``'inherited-members'``: See :rst:dir:`autoclass:inherited-members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1033 +msgid "``'imported-members'``: See :rst:dir:`automodule:imported-members`." msgstr "" #: ../../sphinx/doc/usage/extensions/autodoc.rst:1034 -msgid "Added ``'class-doc-from'``." +msgid "``'exclude-members'``: See :rst:dir:`automodule:exclude-members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1035 +msgid "``'ignore-module-all'``: See :rst:dir:`automodule:ignore-module-all`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1036 +msgid "``'member-order'``: See :rst:dir:`automodule:member-order`." msgstr "" #: ../../sphinx/doc/usage/extensions/autodoc.rst:1037 +msgid "``'show-inheritance'``: See :rst:dir:`autoclass:show-inheritance`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1038 +msgid "``'class-doc-from'``: See :rst:dir:`autoclass:class-doc-from`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1039 +msgid "``'no-value'``: See :rst:dir:`autodata:no-value`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1043 +msgid "Accepts ``True`` as a value." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1046 +msgid "Added ``'imported-members'``." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1049 +msgid "Added ``'class-doc-from'``." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1052 msgid "Added ``'no-value'``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1042 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1059 msgid "" "Functions imported from C modules cannot be introspected, and therefore the " "signature for such functions cannot be automatically determined. However, " @@ -867,7 +926,7 @@ msgid "" "the function's docstring." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1047 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1064 msgid "" "If this boolean value is set to ``True`` (which is the default), autodoc " "will look at the first line of the docstring for functions and methods, and " @@ -875,22 +934,22 @@ msgid "" "from the docstring content." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1052 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1069 msgid "" "autodoc will continue to look for multiple signature lines, stopping at the " "first line that does not look like a signature. This is useful for declaring" " overloaded function signatures." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1059 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1076 msgid "Support overloaded signatures" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1063 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1080 msgid "Overloaded signatures do not need to be separated by a backslash" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1067 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1086 msgid "" "This value contains a list of modules to be mocked up. This is useful when " "some external dependencies are not met at build time and break the building " @@ -898,198 +957,194 @@ msgid "" "themselves and omit the sub-modules:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1076 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1095 msgid "Will mock all imports under the ``django`` package." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1080 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1099 msgid "" "This config value only requires to declare the top-level modules that should" " be mocked." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1086 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1107 msgid "" "This value controls how to represent typehints. The setting takes the " "following values:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1089 -msgid "``'signature'`` -- Show typehints in the signature (default)" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1110 +msgid "``'signature'`` -- Show typehints in the signature" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1090 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1111 msgid "" "``'description'`` -- Show typehints as content of the function or method The" " typehints of overloaded functions or methods will still be represented in " "the signature." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1093 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1114 msgid "``'none'`` -- Do not show typehints" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1094 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1115 msgid "" "``'both'`` -- Show typehints in the signature and as content of the function" " or method" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1097 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1118 msgid "" "Overloaded functions or methods will not have typehints included in the " "description because it is impossible to accurately represent all possible " "overloads as a list of parameters." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1104 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1125 msgid "New option ``'description'`` is added." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1108 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1129 msgid "New option ``'both'`` is added." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1112 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1135 msgid "" "This value controls whether the types of undocumented parameters and return " -"values are documented when ``autodoc_typehints`` is set to ``description``." +"values are documented when :confval:`autodoc_typehints` is set to " +"``'description'``. Supported values:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1115 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1140 msgid "" -"The default value is ``\"all\"``, meaning that types are documented for all " -"parameters and return values, whether they are documented or not." +"``'all'``: Types are documented for all parameters and return values, " +"whether they are documented or not." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1118 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1143 msgid "" -"When set to ``\"documented\"``, types will only be documented for a " -"parameter or a return value that is already documented by the docstring." +"``'documented'``: Types will only be documented for a parameter or a return " +"value that is already documented by the docstring." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1121 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1146 msgid "" -"With ``\"documented_params\"``, parameter types will only be annotated if " -"the parameter is documented in the docstring. The return type is always " +"``'documented_params'``: Parameter types will only be annotated if the " +"parameter is documented in the docstring. The return type is always " "annotated (except if it is ``None``)." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1129 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1155 msgid "New option ``'documented_params'`` is added." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1133 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1161 msgid "" "A dictionary for users defined `type aliases`__ that maps a type name to the" " full-qualified object name. It is used to keep type aliases not evaluated " -"in the document. Defaults to empty (``{}``)." +"in the document." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1137 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1165 msgid "" "The type aliases are only available if your program enables :pep:`Postponed " "Evaluation of Annotations (PEP 563) <563>` feature via ``from __future__ " "import annotations``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1141 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1169 msgid "For example, there is code using a type alias:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1152 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1180 msgid "" "If ``autodoc_type_aliases`` is not set, autodoc will generate internal mark-" "up from this code as following:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1161 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1189 msgid "" "If you set ``autodoc_type_aliases`` as ``{'AliasType': " "'your.module.AliasType'}``, it generates the following document internally:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1176 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1206 msgid "" "This value controls the format of typehints. The setting takes the " "following values:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1179 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1209 msgid "" "``'fully-qualified'`` -- Show the module name and its name of typehints" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1180 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1210 msgid "" "``'short'`` -- Suppress the leading module names of the typehints (e.g. " -"``io.StringIO`` -> ``StringIO``) (default)" +"``io.StringIO`` -> ``StringIO``)" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1187 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1217 msgid "The default setting was changed to ``'short'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1191 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1223 msgid "" "If True, the default argument values of functions will be not evaluated on " "generating document. It preserves them as is in the source code." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1196 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1228 msgid "" "Added as an experimental feature. This will be integrated into autodoc core" " in the future." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1201 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1235 msgid "" "This value controls the behavior of :option:`sphinx-build --fail-on-warning`" " during importing modules. If ``False`` is given, autodoc forcedly " -"suppresses the error if the imported module emits warnings. By default, " -"``True``." +"suppresses the error if the imported module emits warnings." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1206 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1240 msgid "" "This option now has no effect as :option:`!--fail-on-warning` no longer " "exits early." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1212 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1248 msgid "" "This value controls the docstrings inheritance. If set to True the docstring" " for classes or methods, if not explicitly set, is inherited from parents." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1216 -msgid "The default is ``True``." -msgstr "" - -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1223 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1259 msgid "" -":mod:`autodoc` supports to suppress warning messages via " -":confval:`suppress_warnings`. It allows following warnings types in " -"addition:" +":mod:`autodoc` supports suppressing warning messages via " +":confval:`suppress_warnings`. It defines the following additional warnings " +"types:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1227 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1263 msgid "autodoc" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1228 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1264 msgid "autodoc.import_object" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1232 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1268 msgid "Docstring preprocessing" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1234 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1270 msgid "autodoc provides the following additional events:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1240 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1276 msgid "" "Emitted when autodoc has read and processed a docstring. *lines* is a list " "of strings -- the lines of the processed docstring -- that the event handler" @@ -1100,41 +1155,40 @@ msgstr "" msgid "Parameters" msgstr "Parámetros" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1244 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1263 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1275 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1304 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1336 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1280 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1299 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1311 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1340 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1372 msgid "the Sphinx application object" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1245 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1276 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1337 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1281 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1312 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1373 msgid "" -"the type of the object which the docstring belongs to (one of " -"``\"module\"``, ``\"class\"``, ``\"exception\"``, ``\"function\"``, " -"``\"method\"``, ``\"attribute\"``)" +"the type of the object which the docstring belongs to (one of ``'module'``, " +"``'class'``, ``'exception'``, ``'function'``, ``'method'``, ``'attribute'``)" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1248 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1279 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1305 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1340 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1284 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1315 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1341 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1376 msgid "the fully qualified name of the object" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1249 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1264 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1280 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1306 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1341 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1285 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1300 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1316 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1342 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1377 msgid "the object itself" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1250 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1281 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1344 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1286 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1317 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1380 msgid "" "the options given to the directive: an object with attributes " "``inherited_members``, ``undoc_members``, ``show_inheritance`` and ``no-" @@ -1142,41 +1196,41 @@ msgid "" "directive" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1254 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1290 msgid "the lines of the docstring, see above" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1260 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1296 msgid "" "Emitted before autodoc formats a signature for an object. The event handler " "can modify an object to change its signature." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1265 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1301 msgid "a boolean indicates an object is bound method or not" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1271 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1307 msgid "" "Emitted when autodoc has formatted a signature for an object. The event " "handler can return a new tuple ``(signature, return_annotation)`` to change " "what Sphinx puts into the output." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1285 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1321 msgid "" -"function signature, as a string of the form ``\"(parameter_1, " -"parameter_2)\"``, or ``None`` if introspection didn't succeed and signature " +"function signature, as a string of the form ``'(parameter_1, " +"parameter_2)'``, or ``None`` if introspection didn't succeed and signature " "wasn't specified in the directive." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1288 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1324 msgid "" -"function return annotation as a string of the form ``\" -> annotation\"``, " -"or ``None`` if there is no return annotation" +"function return annotation as a string of the form ``' -> annotation'``, or " +"``None`` if there is no return annotation" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1291 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1327 msgid "" "The :mod:`sphinx.ext.autodoc` module provides factory functions for commonly" " needed docstring processing in event :event:`autodoc-process-docstring`:" @@ -1217,7 +1271,7 @@ msgid "" " be processed." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1299 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1335 msgid "" "Emitted when autodoc has read and processed a class to determine the base-" "classes. *bases* is a list of classes that the event handler can modify " @@ -1225,38 +1279,38 @@ msgid "" "if ``show-inheritance`` option given." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1307 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1343 msgid "the options given to the class directive" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1308 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1344 msgid "the list of base classes signature. see above." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1313 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1349 msgid "" "``bases`` can contain a string as a base class name. It will be processed as" " reStructuredText." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1318 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1354 msgid "Skipping members" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1320 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1356 msgid "" "autodoc allows the user to define a custom method for determining whether a " "member should be included in the documentation by using the following event:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1327 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1363 msgid "" "Emitted when autodoc has to decide whether a member should be included in " "the documentation. The member is excluded if a handler returns ``True``. " "It is included if the handler returns ``False``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1331 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1367 msgid "" "If more than one enabled extension handles the ``autodoc-skip-member`` " "event, autodoc will use the first non-``None`` value returned by a handler. " @@ -1264,7 +1318,7 @@ msgid "" "autodoc and other enabled extensions." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1342 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1378 msgid "" "a boolean indicating if autodoc will skip this member if the user handler " "does not override the decision" diff --git a/locale/fr/LC_MESSAGES/changes/1.8.po b/locale/fr/LC_MESSAGES/changes/1.8.po index 03545a724a..8dd654c3c2 100644 --- a/locale/fr/LC_MESSAGES/changes/1.8.po +++ b/locale/fr/LC_MESSAGES/changes/1.8.po @@ -14,7 +14,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-10-01 00:54+0000\n" +"POT-Creation-Date: 2024-10-03 00:49+0000\n" "PO-Revision-Date: 2024-07-31 00:36+0000\n" "Last-Translator: LAURENT Raphaël , 2024\n" "Language-Team: French (https://app.transifex.com/sphinx-doc/teams/15434/fr/)\n" @@ -403,7 +403,7 @@ msgstr "" #: ../../sphinx/doc/changes/1.8.rst:150 msgid "" "#5421: autodoc emits deprecation warning for " -":confval:`autodoc_default_flags`" +":confval:`!autodoc_default_flags`" msgstr "" #: ../../sphinx/doc/changes/1.8.rst:151 @@ -671,7 +671,7 @@ msgid ":confval:`!source_parsers` is deprecated" msgstr "" #: ../../sphinx/doc/changes/1.8.rst:254 -msgid ":confval:`autodoc_default_flags` is deprecated" +msgid ":confval:`!autodoc_default_flags` is deprecated" msgstr "" #: ../../sphinx/doc/changes/1.8.rst:255 diff --git a/locale/fr/LC_MESSAGES/changes/index.po b/locale/fr/LC_MESSAGES/changes/index.po index 1d8ba08d4c..cbac216444 100644 --- a/locale/fr/LC_MESSAGES/changes/index.po +++ b/locale/fr/LC_MESSAGES/changes/index.po @@ -13,7 +13,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-09-28 00:48+0000\n" +"POT-Creation-Date: 2024-10-03 00:49+0000\n" "PO-Revision-Date: 2024-07-31 00:36+0000\n" "Last-Translator: LAURENT Raphaël , 2024\n" "Language-Team: French (https://app.transifex.com/sphinx-doc/teams/15434/fr/)\n" @@ -240,11 +240,18 @@ msgid "" ":rst:dir:`py:module` directives. Patch by Stephen Finucane." msgstr "" -#: ../../sphinx/CHANGES.rst:112 +#: ../../sphinx/CHANGES.rst:110 +msgid "" +"#12916: Restore support for custom templates named with the legacy ``_t`` " +"suffix during ``apidoc`` RST rendering (regression in 7.4.0). Patch by James" +" Addison." +msgstr "" + +#: ../../sphinx/CHANGES.rst:115 msgid "Testing" msgstr "En cours de test" -#: ../../sphinx/CHANGES.rst:114 +#: ../../sphinx/CHANGES.rst:117 msgid "" "#12141: Migrate from the deprecated ``karma`` JavaScript test framework to " "the actively-maintained ``jasmine`` framework. Test coverage is unaffected." diff --git a/locale/fr/LC_MESSAGES/extdev/deprecated.po b/locale/fr/LC_MESSAGES/extdev/deprecated.po index ff39af4bbf..882af6858c 100644 --- a/locale/fr/LC_MESSAGES/extdev/deprecated.po +++ b/locale/fr/LC_MESSAGES/extdev/deprecated.po @@ -13,7 +13,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-09-02 00:47+0000\n" +"POT-Creation-Date: 2024-10-03 00:50+0000\n" "PO-Revision-Date: 2019-03-09 18:04+0000\n" "Last-Translator: Rafael Fontenelle , 2024\n" "Language-Team: French (https://app.transifex.com/sphinx-doc/teams/15434/fr/)\n" @@ -2854,8 +2854,8 @@ msgid ":meth:`~sphinx.application.Sphinx.add_js_file`" msgstr "" #: ../../sphinx/doc/extdev/deprecated.rst:1457 -msgid ":confval:`autodoc_default_flags`" -msgstr ":confval:`autodoc_default_flags`" +msgid ":confval:`!autodoc_default_flags`" +msgstr "" #: ../../sphinx/doc/extdev/deprecated.rst:1460 msgid ":confval:`autodoc_default_options`" diff --git a/locale/fr/LC_MESSAGES/usage/domains/restructuredtext.po b/locale/fr/LC_MESSAGES/usage/domains/restructuredtext.po index 773fc0b832..6e4864d8f9 100644 --- a/locale/fr/LC_MESSAGES/usage/domains/restructuredtext.po +++ b/locale/fr/LC_MESSAGES/usage/domains/restructuredtext.po @@ -11,7 +11,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-09-15 00:53+0000\n" +"POT-Creation-Date: 2024-10-03 00:49+0000\n" "PO-Revision-Date: 2023-10-03 00:37+0000\n" "Last-Translator: LAURENT Raphaël , 2023\n" "Language-Team: French (https://app.transifex.com/sphinx-doc/teams/15434/fr/)\n" @@ -79,3 +79,20 @@ msgstr "" #: ../../sphinx/doc/usage/domains/restructuredtext.rst:97 msgid "These roles are provided to refer to the described objects:" msgstr "" + +#: ../../sphinx/doc/usage/domains/restructuredtext.rst:101 +msgid "Reference directives and directive options. Examples:" +msgstr "" + +#: ../../sphinx/doc/usage/domains/restructuredtext.rst:103 +msgid "Use ``:rst:dir:`my-directive``` to reference a directive." +msgstr "" + +#: ../../sphinx/doc/usage/domains/restructuredtext.rst:104 +msgid "" +"Use ``:rst:dir:`my-directive:my-option``` to reference a directive option." +msgstr "" + +#: ../../sphinx/doc/usage/domains/restructuredtext.rst:109 +msgid "Reference a role. Example: ``:rst:role:`my-role```." +msgstr "" diff --git a/locale/fr/LC_MESSAGES/usage/extensions/autodoc.po b/locale/fr/LC_MESSAGES/usage/extensions/autodoc.po index 6e7d26ef35..12d86abbfb 100644 --- a/locale/fr/LC_MESSAGES/usage/extensions/autodoc.po +++ b/locale/fr/LC_MESSAGES/usage/extensions/autodoc.po @@ -14,7 +14,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-10-02 00:49+0000\n" +"POT-Creation-Date: 2024-10-03 00:50+0000\n" "PO-Revision-Date: 2018-06-26 15:58+0000\n" "Last-Translator: Jérémie Tarot , 2024\n" "Language-Team: French (https://app.transifex.com/sphinx-doc/teams/15434/fr/)\n" @@ -29,7 +29,7 @@ msgid ":mod:`sphinx.ext.autodoc` -- Include documentation from docstrings" msgstr "" ":mod:`sphinx.ext.autodoc` -- Inclure la documentation des chaînes docstrings" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:12 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:15 msgid "" "This extension can import the modules you are documenting, and pull in " "documentation from docstrings in a semi-automatic way." @@ -37,20 +37,20 @@ msgstr "" "Cette extension permet d'importer les modules que vous documentez, et " "d'extraire la documentation des docstrings de manière semi-automatique." -#: ../../sphinx/doc/usage/extensions/autodoc.rst:17 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:20 msgid "" ":mod:`~sphinx.ext.autodoc` **imports** the modules to be documented. If any " "modules have side effects on import, these will be executed by ``autodoc`` " "when :program:`sphinx-build` is run." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:21 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:24 msgid "" "If you document scripts (as opposed to library modules), make sure that the " "main routine is protected by an ``if __name__ == '__main__'`` condition." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:25 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:28 msgid "" "For this to work, the docstrings must of course be written in correct " "reStructuredText. You can then use all of the usual Sphinx markup in the " @@ -60,7 +60,7 @@ msgid "" "auto-generated-looking pure API documentation." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:33 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:36 msgid "" "If you prefer `NumPy`_ or `Google`_ style docstrings over reStructuredText, " "you can also enable the :mod:`napoleon ` extension. " @@ -68,25 +68,25 @@ msgid "" "reStructuredText before ``autodoc`` processes them." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:43 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:46 msgid "Getting started" msgstr "Démarrer avec Sphinx" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:47 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:50 msgid "Setup" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:49 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:52 msgid "" "Activate the plugin by adding ``'sphinx.ext.autodoc'`` to the " ":confval:`extensions` list in :file:`conf.py`:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:61 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:64 msgid "Ensuring the code can be imported" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:63 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:66 msgid "" ":mod:`~sphinx.ext.autodoc` analyses the code and docstrings by introspection" " after **importing the modules**. For importing to work, you have to make " @@ -96,11 +96,11 @@ msgid "" "fail)." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:70 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:73 msgid "There are two ways to ensure this:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:72 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:75 msgid "" "Use an environment that contains your package and Sphinx. This can e.g. be " "your local development environment (with an editable install), or an " @@ -109,14 +109,14 @@ msgid "" "that all dependencies are available." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:78 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:81 msgid "" "It is alternatively possible to patch the Sphinx run so that it can operate " "directly on the sources; e.g. if you want to be able to do a Sphinx build " "from a source checkout." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:82 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:85 msgid "" "Patch :data:`sys.path` in :file:`conf.py` to include your source path. For " "example if you have a repository structure with :file:`doc/conf.py` and your" @@ -124,17 +124,17 @@ msgid "" "your :file:`conf.py`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:94 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:97 msgid "" "To cope with missing dependencies, specify the missing modules in the " ":confval:`autodoc_mock_imports` setting." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:99 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:102 msgid "Usage" msgstr "Utilisation" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:101 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:104 msgid "" "You can now use the :ref:`autodoc-directives` to add formatted documentation" " for Python code elements like functions, classes, modules, etc. For " @@ -142,48 +142,48 @@ msgid "" "docstring from the source file, you'd write:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:110 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:113 msgid "" "You can also document whole classes or even modules automatically, using " "member options for the auto directives, like:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:119 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:122 msgid "" "As a hint to autodoc extension, you can put a ``::`` separator between the " "module name and the object name to let autodoc know the correct module, if " "it is ambiguous:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:129 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:132 msgid "Marking objects as public or private" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:131 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:134 msgid "" "autodoc considers a member private if its docstring contains ``:meta " "private:`` in its :ref:`info-field-lists`. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:145 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:148 msgid "" "autodoc considers a member public if its docstring contains ``:meta " "public:`` in its :ref:`info-field-lists`, even if it starts with an " "underscore. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:160 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:163 msgid "" "autodoc considers a variable member does not have any default value if its " "docstring contains ``:meta hide-value:`` in its :ref:`info-field-lists`. " "Example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:174 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:177 msgid "Doc comments and docstrings" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:176 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:179 msgid "" "Python has no built-in support for docstrings for module data members or " "class attributes. To allow documenting these, ``autodoc`` recognises a " @@ -191,7 +191,7 @@ msgid "" " 'documentation comment'." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:181 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:184 msgid "" "These comments start with a colon and an optional space character, ``'#:'`` " "or ``'#: '``. To be recognised, the comments must appear either on the same " @@ -200,28 +200,28 @@ msgid "" "definition." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:188 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:191 msgid "" "For example, all three of the following variables have valid doc-comments:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:202 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:205 msgid "" "Alternatively, ``autodoc`` can recognise a docstring on the line immediately" " following the definition." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:205 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:208 msgid "" "In the the following class definition, all attributes have documentation " "recognised by ``autodoc``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:233 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:236 msgid "Directives" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:235 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:238 msgid "" ":mod:`autodoc` provides several directives that are versions of the usual " ":rst:dir:`py:module`, :rst:dir:`py:class` and so forth. On parsing time, " @@ -230,24 +230,24 @@ msgid "" ":rst:dir:`py:module`, :rst:dir:`py:class` etc. directive." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:244 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:247 msgid "" "Just as :rst:dir:`py:class` respects the current :rst:dir:`py:module`, " ":rst:dir:`autoclass` will also do so. Likewise, :rst:dir:`automethod` will " "respect the current :rst:dir:`py:class`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:250 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:253 msgid "Default directive options" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:252 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:255 msgid "" "To make any of the options described below the default, use the " ":confval:`autodoc_default_options` dictionary in :file:`conf.py`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:255 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:258 msgid "" "If using defaults for the ``:members:``, ``:exclude-members:``, ``:private-" "members:``, or ``:special-members:`` options, setting the option on a " @@ -256,111 +256,111 @@ msgid "" "(``+``), as follows:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:269 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:272 msgid "" "If using :confval:`autodoc_default_options`, the defaults can be disabled " "per-directive with the negated form, :samp:`:no-{option}:` as an option of " "the directive For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:281 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:284 msgid "Automatically document modules" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:285 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:288 msgid "" "Document a module. By default, the directive only inserts the docstring of " "the module itself:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:292 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:526 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:792 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:866 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:295 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:531 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:797 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:871 msgid "will produce source like this:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:300 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:534 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:303 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:539 msgid "" "The directive can also contain content of its own, which will be inserted " "into the resulting non-auto directive source after the docstring (but before" " any automatic member documentation)." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:304 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:538 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:878 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:307 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:543 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:883 msgid "" "Therefore, you can also mix automatic and non-automatic member " "documentation, as follows:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:317 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:567 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:844 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:894 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:320 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:572 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:849 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:899 msgid "Options" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:321 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:324 msgid "" "Do not generate an index entry for the documented module or any auto-" "documented members." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:329 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:332 msgid "" "Indicate platforms on which the module is available. This is identical to " ":rst:dir:`py:module`'s ``:platform:`` option." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:335 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:338 msgid "" "A sentence describing the module's purpose. This is identical to " ":rst:dir:`py:module`'s ``:synopsis:`` option." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:343 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:346 msgid "" "Mark a module as deprecated. This is identical to :rst:dir:`py:module`'s " "``:deprecated:`` option." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:351 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:354 msgid "Do not use ``__all__`` when analysing the module to document." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:356 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:600 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:359 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:605 msgid "Options for selecting members to document" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:360 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:363 msgid "Generate automatic documentation for all members of the target module:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:367 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:370 msgid "" "By default, ``autodoc`` only includes public members with a docstring or " ":ref:`doc-comment ` (``#:``). If ``__all__`` exists, it will be" -" used to define which members are public, unless the ``:ignore-module-all:``" -" option is set." +" used to define which members are public, unless the :rst:dir:`:ignore-" +"module-all: ` option is set." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:372 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:615 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:376 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:620 msgid "" "To only document certain members, an explicit comma-separated list may be " "used as the argument to ``:members:``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:383 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:626 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:387 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:631 msgid "Exclude the given names from the members to document. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:397 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:401 msgid "" "To prevent documentation of imported classes or functions, in an " ":rst:dir:`!automodule` directive with the ``members`` option set, only " @@ -368,198 +368,197 @@ msgid "" "name given to ``automodule`` will be documented." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:402 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:406 msgid "" "Set the ``imported-members`` option if you want to prevent this behavior and" " document all available members." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:405 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:409 msgid "" "Note that attributes from imported modules will not be documented, because " "attribute documentation is discovered by parsing the source file of the " "current module." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:414 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:418 msgid "" "Generate automatic documentation for members of the target module that don't" " have a docstring or doc-comment. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:427 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:431 msgid "" "Generate automatic documentation for private members of the target module. " "This includes names with a leading underscore (e.g. ``_private``) and those " "members explicitly marked as private with ``:meta private:``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:437 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:703 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:441 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:708 msgid "" "To only document certain private members, an explicit comma-separated list " "may be used as the argument to ``:private-members:``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:447 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:475 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:741 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:451 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:479 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:746 msgid "The option can now take a comma-separated list of arguments." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:453 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:457 msgid "" "Generate automatic documentation for special members of the target module, " -"also known as :ref:`\"dunder\" names `. This includes " -"all names enclosed with a double-underscore, e.g. ``__special__``:" +"also known as :ref:`'dunder' names `. This includes all" +" names enclosed with a double-underscore, e.g. ``__special__``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:464 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:730 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:468 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:735 msgid "" "To only document certain special members, an explicit comma-separated list " "may be used as the argument to ``:special-members:``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:479 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:745 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:483 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:750 msgid "Options for documented members" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:483 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:749 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:487 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:754 msgid "" "Choose the ordering of automatically documented members (default: " "``alphabetical``). This overrides the :confval:`autodoc_member_order` " "setting." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:487 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:491 msgid "``alphabetical``: Use simple alphabetical order." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:489 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:493 msgid "" "``groupwise``: Group by object type (class, function, etc), use alphabetical" " order within groups." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:492 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:496 msgid "" "``bysource``: Use the order of objects in the module's source. The " "``__all__`` variable can be used to override this order." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:496 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:762 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:980 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:500 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:767 msgid "" "Note that for source order, the module must be a Python module with the " "source code available." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:500 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:766 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:504 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:771 msgid "Support the ``'bysource'`` option." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:506 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:510 msgid "" -"Enable the ``:show-inheritance:`` option for all members of the module, if " -"``:members:`` is enabled." +"Enable the :rst:dir:`:show-inheritance: ` option" +" for all members of the module, if ``:members:`` is enabled." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:513 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:518 msgid "Automatically document classes or exceptions" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:518 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:523 msgid "" -"Document a class. For exception classes, prefer ``autoexception``. By " +"Document a class. For exception classes, prefer ``.. autoexception::``. By " "default, the directive only inserts the docstring of the class itself:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:551 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:828 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:556 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:833 msgid "Advanced usage" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:552 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:829 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:557 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:834 msgid "" "It is possible to override the signature for explicitly documented callable " "objects (functions, methods, classes) with the regular syntax that will " "override the signature gained from introspection:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:562 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:839 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:567 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:844 msgid "" "This is useful if the signature from the method is hidden by a decorator." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:571 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:898 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:576 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:903 msgid "" "Do not generate an index entry for the documented class or any auto-" "documented members." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:579 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:584 msgid "" "Select which docstring will be used for the main body of the directive. This" " overrides the global value of :confval:`autoclass_content`. The possible " "values are:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:583 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:588 msgid "" "``class``: Only use the class's docstring. The :meth:`!__init__` method can " "be separately documented using the ``:members:`` option or " ":rst:dir:`automethod`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:587 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:592 msgid "``init``: Only use the docstring of the :meth:`!__init__` method." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:589 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:594 msgid "" -"``both`` Use both, appending the docstring of the :meth:`!__init__` method " +"``both``: Use both, appending the docstring of the :meth:`!__init__` method " "to the class's docstring." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:593 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:598 msgid "" "If the :meth:`!__init__` method doesn't exist or has a blank docstring, " "``autodoc`` will attempt to use the :meth:`!__new__` method's docstring, if " "it exists and is not blank." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:604 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:609 msgid "Generate automatic documentation for all members of the target class:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:611 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:616 msgid "" "By default, ``autodoc`` only includes public members with a docstring or " ":ref:`doc-comment ` (``#:``) that are attributes of the target " "class (i.e. not inherited)." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:640 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:645 msgid "" "To generate automatic documentation for members inherited from base classes," " use the ``:inherited-members:`` option:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:649 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:654 msgid "" "This can be combined with the ``:undoc-members:`` option to generate " "automatic documentation for *all* available members of the class." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:652 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:657 msgid "" "The members of classes listed in the argument to ``:inherited-members:`` are" " excluded from the automatic documentation. This defaults to " @@ -568,105 +567,105 @@ msgid "" "as the argument." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:658 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:663 msgid "" "For example; If your class ``MyList`` is derived from ``list`` class and you" " don't want to document ``list.__len__()``, you should specify a option " "``:inherited-members: list`` to avoid special members of list class." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:664 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:669 msgid "" "Should any of the inherited members use a format other than reStructuredText" " for their docstrings, there may be markup warnings or errors." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:670 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:675 msgid "" "``:inherited-members:`` now takes the name of a base class to exclude as an " "argument." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:674 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:679 msgid "A comma separated list of base class names can be used." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:680 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:685 msgid "" "Generate automatic documentation for members of the target class that don't " "have a docstring or doc-comment. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:693 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:698 msgid "" "Generate automatic documentation for private members of the target class. " "This includes names with a leading underscore (e.g. ``_private``) and those " "members explicitly marked as private with ``:meta private:``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:713 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:718 msgid "The option can now take arguments." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:719 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:724 msgid "" "Generate automatic documentation for special members of the target class, " -"also known as :ref:`\"dunder\" names `. This includes " -"all names enclosed with a double-underscore, e.g. ``__special__``:" +"also known as :ref:`'dunder' names `. This includes all" +" names enclosed with a double-underscore, e.g. ``__special__``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:753 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:758 msgid "``'alphabetical'``: Use simple alphabetical order." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:755 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:760 msgid "" "``'groupwise'``: Group by object type (class, function, etc), use " "alphabetical order within groups." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:758 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:763 msgid "" "``'bysource'``: Use the order of objects in the module's source. The " "``__all__`` variable can be used to override this order." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:772 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:777 msgid "Insert the class's base classes after the class signature." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:778 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:783 msgid "Automatically document function-like objects" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:785 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:790 msgid "" "Document a function, method, property, or decorator. By default, the " "directive only inserts the docstring of the function itself:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:800 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:874 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:805 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:879 msgid "" "The directive can also contain content of its own, which will be inserted " "into the resulting non-auto directive source after the docstring." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:804 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:809 msgid "" "Therefore, you can also mix automatic and non-automatic documentation, as " "follows:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:813 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:818 msgid ":rst:dir:`autodecorator`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:815 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:820 msgid ":rst:dir:`autoproperty`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:820 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:825 msgid "" "If you document decorated functions or methods, keep in mind that " "``autodoc`` retrieves its docstrings by importing the module and inspecting " @@ -675,30 +674,30 @@ msgid "" "the original ``__doc__`` to the new function." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:848 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:853 msgid "Do not generate an index entry for the documented function." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:854 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:859 msgid "Automatically document attributes or data" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:859 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:864 msgid "" "Document a module level variable or constant ('data') or class attribute. By" " default, the directive only inserts the docstring of the variable itself:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:887 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:892 msgid "" ":rst:dir:`autodata` and :rst:dir:`autoattribute` can now extract docstrings." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:890 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:895 msgid "Doc-comments are now allowed on the same line of an assignment." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:908 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:913 msgid "" "By default, ``autodoc`` attempts to obtain the type annotation and value of " "the variable by introspection, displaying it after the variable's name. To " @@ -706,165 +705,225 @@ msgid "" "argument to ``annotation``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:914 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:919 msgid "" "For example, if the runtime value of ``FILE_MODE`` is ``0o755``, the " "displayed value will be ``493`` (as ``oct(493) == '0o755'``). This can be " "fixed by setting ``:annotation: = 0o755``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:918 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:923 msgid "" -"If ``annotation`` is used without arguments, no value or type hint will be " -"shown for the variable." +"If ``:annotation:`` is used without arguments, no value or type hint will be" +" shown for the variable." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:925 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:930 msgid "" -"To display the type hint of the variable without a value, use the ``no-" -"value`` option. If both the ``annotation`` and ``no-value`` options are " -"used, ``no-value`` has no effect." +"To display the type hint of the variable without a value, use the ``:no-" +"value:`` option. If both the ``:annotation:`` and ``:no-value:`` options are" +" used, ``:no-value:`` has no effect." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:932 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:937 msgid "Configuration" msgstr "Configuration" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:934 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:939 msgid "There are also config values that you can set:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:938 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:0 +msgid "Type" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:0 +msgid "Default" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:945 msgid "" "This value selects what content will be inserted into the main body of an " ":rst:dir:`autoclass` directive. The possible values are:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:941 -msgid "``\"class\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:948 +msgid "``'class'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:942 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:949 msgid "" -"Only the class' docstring is inserted. This is the default. You can still " -"document ``__init__`` as a separate method using :rst:dir:`automethod` or " -"the ``members`` option to :rst:dir:`autoclass`." +"Only the class' docstring is inserted. You can still document ``__init__`` " +"as a separate method using :rst:dir:`automethod` or the ``members`` option " +"to :rst:dir:`autoclass`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:945 -msgid "``\"both\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:952 +msgid "``'both'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:946 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:953 msgid "" "Both the class' and the ``__init__`` method's docstring are concatenated and" " inserted." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:948 -msgid "``\"init\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:955 +msgid "``'init'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:949 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:956 msgid "Only the ``__init__`` method's docstring is inserted." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:953 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:960 msgid "" "If the class has no ``__init__`` method or if the ``__init__`` method's " "docstring is empty, but the class has a ``__new__`` method's docstring, it " "is used instead." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:961 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:970 msgid "" "This value selects how the signature will be displayed for the class defined" " by :rst:dir:`autoclass` directive. The possible values are:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:964 -msgid "``\"mixed\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:973 +msgid "``'mixed'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:965 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:974 msgid "Display the signature with the class name." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:966 -msgid "``\"separated\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:975 +msgid "``'separated'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:967 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:976 msgid "Display the signature as a method." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:969 -msgid "The default is ``\"mixed\"``." -msgstr "" - -#: ../../sphinx/doc/usage/extensions/autodoc.rst:975 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:984 msgid "" -"This value selects if automatically documented members are sorted " -"alphabetical (value ``'alphabetical'``), by member type (value " -"``'groupwise'``) or by source order (value ``'bysource'``). The default is " -"alphabetical." +"Define the order in which :rst:dir:`automodule` and :rst:dir:`autoclass` " +"members are listed. Supported values are:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:984 -msgid "Support for ``'bysource'``." +#: ../../sphinx/doc/usage/extensions/autodoc.rst:987 +msgid "``'alphabetical'``: Use alphabetical order." msgstr "" #: ../../sphinx/doc/usage/extensions/autodoc.rst:989 +msgid "``'groupwise'``: order by member type. The order is:" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:991 +msgid "for modules, exceptions, classes, functions, data" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:992 +msgid "for classes: methods, then properties and attributes" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:994 +msgid "Members are ordered alphabetically within groups." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:996 msgid "" -"This value is a list of autodoc directive flags that should be automatically" -" applied to all autodoc directives. The supported flags are ``'members'``, " -"``'undoc-members'``, ``'private-members'``, ``'special-members'``, " -"``'inherited-members'``, ``'show-inheritance'``, ``'ignore-module-all'`` and" -" ``'exclude-members'``." +"``'bysource'``: Use the order in which the members appear in the source " +"code. This requires that the module must be a Python module with the source " +"code available." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:999 -msgid "Integrated into :confval:`autodoc_default_options`." +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1002 +msgid "Support for ``'bysource'``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1003 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1009 msgid "" "The default options for autodoc directives. They are applied to all autodoc" " directives automatically. It must be a dictionary which maps option names " "to the values. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1017 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1023 msgid "" "Setting ``None`` or ``True`` to the value is equivalent to giving only the " "option name to the directives." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1020 -msgid "" -"The supported options are ``'members'``, ``'member-order'``, ``'undoc-" -"members'``, ``'private-members'``, ``'special-members'``, ``'inherited-" -"members'``, ``'show-inheritance'``, ``'ignore-module-all'``, ``'imported-" -"members'``, ``'exclude-members'``, ``'class-doc-from'`` and ``'no-value'``." +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1026 +msgid "The supported options are:" msgstr "" #: ../../sphinx/doc/usage/extensions/autodoc.rst:1028 -msgid "Accepts ``True`` as a value." +msgid "``'members'``: See :rst:dir:`automodule:members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1029 +msgid "``'undoc-members'`` See :rst:dir:`automodule:undoc-members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1030 +msgid "``'private-members'``: See :rst:dir:`automodule:private-members`." msgstr "" #: ../../sphinx/doc/usage/extensions/autodoc.rst:1031 -msgid "Added ``'imported-members'``." +msgid "``'special-members'``: See :rst:dir:`automodule:special-members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1032 +msgid "``'inherited-members'``: See :rst:dir:`autoclass:inherited-members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1033 +msgid "``'imported-members'``: See :rst:dir:`automodule:imported-members`." msgstr "" #: ../../sphinx/doc/usage/extensions/autodoc.rst:1034 -msgid "Added ``'class-doc-from'``." +msgid "``'exclude-members'``: See :rst:dir:`automodule:exclude-members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1035 +msgid "``'ignore-module-all'``: See :rst:dir:`automodule:ignore-module-all`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1036 +msgid "``'member-order'``: See :rst:dir:`automodule:member-order`." msgstr "" #: ../../sphinx/doc/usage/extensions/autodoc.rst:1037 +msgid "``'show-inheritance'``: See :rst:dir:`autoclass:show-inheritance`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1038 +msgid "``'class-doc-from'``: See :rst:dir:`autoclass:class-doc-from`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1039 +msgid "``'no-value'``: See :rst:dir:`autodata:no-value`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1043 +msgid "Accepts ``True`` as a value." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1046 +msgid "Added ``'imported-members'``." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1049 +msgid "Added ``'class-doc-from'``." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1052 msgid "Added ``'no-value'``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1042 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1059 msgid "" "Functions imported from C modules cannot be introspected, and therefore the " "signature for such functions cannot be automatically determined. However, " @@ -872,7 +931,7 @@ msgid "" "the function's docstring." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1047 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1064 msgid "" "If this boolean value is set to ``True`` (which is the default), autodoc " "will look at the first line of the docstring for functions and methods, and " @@ -880,22 +939,22 @@ msgid "" "from the docstring content." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1052 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1069 msgid "" "autodoc will continue to look for multiple signature lines, stopping at the " "first line that does not look like a signature. This is useful for declaring" " overloaded function signatures." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1059 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1076 msgid "Support overloaded signatures" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1063 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1080 msgid "Overloaded signatures do not need to be separated by a backslash" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1067 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1086 msgid "" "This value contains a list of modules to be mocked up. This is useful when " "some external dependencies are not met at build time and break the building " @@ -903,198 +962,194 @@ msgid "" "themselves and omit the sub-modules:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1076 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1095 msgid "Will mock all imports under the ``django`` package." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1080 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1099 msgid "" "This config value only requires to declare the top-level modules that should" " be mocked." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1086 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1107 msgid "" "This value controls how to represent typehints. The setting takes the " "following values:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1089 -msgid "``'signature'`` -- Show typehints in the signature (default)" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1110 +msgid "``'signature'`` -- Show typehints in the signature" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1090 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1111 msgid "" "``'description'`` -- Show typehints as content of the function or method The" " typehints of overloaded functions or methods will still be represented in " "the signature." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1093 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1114 msgid "``'none'`` -- Do not show typehints" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1094 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1115 msgid "" "``'both'`` -- Show typehints in the signature and as content of the function" " or method" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1097 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1118 msgid "" "Overloaded functions or methods will not have typehints included in the " "description because it is impossible to accurately represent all possible " "overloads as a list of parameters." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1104 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1125 msgid "New option ``'description'`` is added." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1108 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1129 msgid "New option ``'both'`` is added." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1112 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1135 msgid "" "This value controls whether the types of undocumented parameters and return " -"values are documented when ``autodoc_typehints`` is set to ``description``." +"values are documented when :confval:`autodoc_typehints` is set to " +"``'description'``. Supported values:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1115 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1140 msgid "" -"The default value is ``\"all\"``, meaning that types are documented for all " -"parameters and return values, whether they are documented or not." +"``'all'``: Types are documented for all parameters and return values, " +"whether they are documented or not." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1118 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1143 msgid "" -"When set to ``\"documented\"``, types will only be documented for a " -"parameter or a return value that is already documented by the docstring." +"``'documented'``: Types will only be documented for a parameter or a return " +"value that is already documented by the docstring." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1121 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1146 msgid "" -"With ``\"documented_params\"``, parameter types will only be annotated if " -"the parameter is documented in the docstring. The return type is always " +"``'documented_params'``: Parameter types will only be annotated if the " +"parameter is documented in the docstring. The return type is always " "annotated (except if it is ``None``)." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1129 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1155 msgid "New option ``'documented_params'`` is added." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1133 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1161 msgid "" "A dictionary for users defined `type aliases`__ that maps a type name to the" " full-qualified object name. It is used to keep type aliases not evaluated " -"in the document. Defaults to empty (``{}``)." +"in the document." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1137 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1165 msgid "" "The type aliases are only available if your program enables :pep:`Postponed " "Evaluation of Annotations (PEP 563) <563>` feature via ``from __future__ " "import annotations``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1141 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1169 msgid "For example, there is code using a type alias:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1152 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1180 msgid "" "If ``autodoc_type_aliases`` is not set, autodoc will generate internal mark-" "up from this code as following:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1161 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1189 msgid "" "If you set ``autodoc_type_aliases`` as ``{'AliasType': " "'your.module.AliasType'}``, it generates the following document internally:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1176 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1206 msgid "" "This value controls the format of typehints. The setting takes the " "following values:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1179 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1209 msgid "" "``'fully-qualified'`` -- Show the module name and its name of typehints" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1180 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1210 msgid "" "``'short'`` -- Suppress the leading module names of the typehints (e.g. " -"``io.StringIO`` -> ``StringIO``) (default)" +"``io.StringIO`` -> ``StringIO``)" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1187 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1217 msgid "The default setting was changed to ``'short'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1191 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1223 msgid "" "If True, the default argument values of functions will be not evaluated on " "generating document. It preserves them as is in the source code." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1196 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1228 msgid "" "Added as an experimental feature. This will be integrated into autodoc core" " in the future." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1201 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1235 msgid "" "This value controls the behavior of :option:`sphinx-build --fail-on-warning`" " during importing modules. If ``False`` is given, autodoc forcedly " -"suppresses the error if the imported module emits warnings. By default, " -"``True``." +"suppresses the error if the imported module emits warnings." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1206 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1240 msgid "" "This option now has no effect as :option:`!--fail-on-warning` no longer " "exits early." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1212 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1248 msgid "" "This value controls the docstrings inheritance. If set to True the docstring" " for classes or methods, if not explicitly set, is inherited from parents." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1216 -msgid "The default is ``True``." -msgstr "La valeur par défaut est ``True``." - -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1223 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1259 msgid "" -":mod:`autodoc` supports to suppress warning messages via " -":confval:`suppress_warnings`. It allows following warnings types in " -"addition:" +":mod:`autodoc` supports suppressing warning messages via " +":confval:`suppress_warnings`. It defines the following additional warnings " +"types:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1227 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1263 msgid "autodoc" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1228 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1264 msgid "autodoc.import_object" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1232 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1268 msgid "Docstring preprocessing" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1234 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1270 msgid "autodoc provides the following additional events:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1240 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1276 msgid "" "Emitted when autodoc has read and processed a docstring. *lines* is a list " "of strings -- the lines of the processed docstring -- that the event handler" @@ -1105,41 +1160,40 @@ msgstr "" msgid "Parameters" msgstr "Paramètres" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1244 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1263 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1275 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1304 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1336 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1280 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1299 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1311 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1340 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1372 msgid "the Sphinx application object" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1245 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1276 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1337 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1281 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1312 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1373 msgid "" -"the type of the object which the docstring belongs to (one of " -"``\"module\"``, ``\"class\"``, ``\"exception\"``, ``\"function\"``, " -"``\"method\"``, ``\"attribute\"``)" +"the type of the object which the docstring belongs to (one of ``'module'``, " +"``'class'``, ``'exception'``, ``'function'``, ``'method'``, ``'attribute'``)" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1248 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1279 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1305 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1340 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1284 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1315 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1341 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1376 msgid "the fully qualified name of the object" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1249 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1264 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1280 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1306 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1341 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1285 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1300 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1316 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1342 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1377 msgid "the object itself" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1250 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1281 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1344 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1286 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1317 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1380 msgid "" "the options given to the directive: an object with attributes " "``inherited_members``, ``undoc_members``, ``show_inheritance`` and ``no-" @@ -1147,41 +1201,41 @@ msgid "" "directive" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1254 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1290 msgid "the lines of the docstring, see above" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1260 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1296 msgid "" "Emitted before autodoc formats a signature for an object. The event handler " "can modify an object to change its signature." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1265 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1301 msgid "a boolean indicates an object is bound method or not" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1271 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1307 msgid "" "Emitted when autodoc has formatted a signature for an object. The event " "handler can return a new tuple ``(signature, return_annotation)`` to change " "what Sphinx puts into the output." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1285 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1321 msgid "" -"function signature, as a string of the form ``\"(parameter_1, " -"parameter_2)\"``, or ``None`` if introspection didn't succeed and signature " +"function signature, as a string of the form ``'(parameter_1, " +"parameter_2)'``, or ``None`` if introspection didn't succeed and signature " "wasn't specified in the directive." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1288 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1324 msgid "" -"function return annotation as a string of the form ``\" -> annotation\"``, " -"or ``None`` if there is no return annotation" +"function return annotation as a string of the form ``' -> annotation'``, or " +"``None`` if there is no return annotation" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1291 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1327 msgid "" "The :mod:`sphinx.ext.autodoc` module provides factory functions for commonly" " needed docstring processing in event :event:`autodoc-process-docstring`:" @@ -1222,7 +1276,7 @@ msgid "" " be processed." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1299 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1335 msgid "" "Emitted when autodoc has read and processed a class to determine the base-" "classes. *bases* is a list of classes that the event handler can modify " @@ -1230,38 +1284,38 @@ msgid "" "if ``show-inheritance`` option given." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1307 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1343 msgid "the options given to the class directive" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1308 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1344 msgid "the list of base classes signature. see above." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1313 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1349 msgid "" "``bases`` can contain a string as a base class name. It will be processed as" " reStructuredText." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1318 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1354 msgid "Skipping members" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1320 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1356 msgid "" "autodoc allows the user to define a custom method for determining whether a " "member should be included in the documentation by using the following event:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1327 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1363 msgid "" "Emitted when autodoc has to decide whether a member should be included in " "the documentation. The member is excluded if a handler returns ``True``. " "It is included if the handler returns ``False``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1331 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1367 msgid "" "If more than one enabled extension handles the ``autodoc-skip-member`` " "event, autodoc will use the first non-``None`` value returned by a handler. " @@ -1269,7 +1323,7 @@ msgid "" "autodoc and other enabled extensions." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1342 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1378 msgid "" "a boolean indicating if autodoc will skip this member if the user handler " "does not override the decision" diff --git a/locale/it_IT/LC_MESSAGES/changes/1.8.po b/locale/it_IT/LC_MESSAGES/changes/1.8.po index 8ff8f95c6e..5a00e3ce97 100644 --- a/locale/it_IT/LC_MESSAGES/changes/1.8.po +++ b/locale/it_IT/LC_MESSAGES/changes/1.8.po @@ -11,7 +11,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-10-01 00:54+0000\n" +"POT-Creation-Date: 2024-10-03 00:49+0000\n" "PO-Revision-Date: 2024-07-31 00:36+0000\n" "Last-Translator: 32e7d1c22f8d835b0e2261bd3e410b47_b6d0d5a <3e3890d708fef81118761bb1d0a44692_389909>, 2024\n" "Language-Team: Italian (Italy) (https://app.transifex.com/sphinx-doc/teams/15434/it_IT/)\n" @@ -400,7 +400,7 @@ msgstr "" #: ../../sphinx/doc/changes/1.8.rst:150 msgid "" "#5421: autodoc emits deprecation warning for " -":confval:`autodoc_default_flags`" +":confval:`!autodoc_default_flags`" msgstr "" #: ../../sphinx/doc/changes/1.8.rst:151 @@ -668,7 +668,7 @@ msgid ":confval:`!source_parsers` is deprecated" msgstr "" #: ../../sphinx/doc/changes/1.8.rst:254 -msgid ":confval:`autodoc_default_flags` is deprecated" +msgid ":confval:`!autodoc_default_flags` is deprecated" msgstr "" #: ../../sphinx/doc/changes/1.8.rst:255 diff --git a/locale/it_IT/LC_MESSAGES/changes/index.po b/locale/it_IT/LC_MESSAGES/changes/index.po index f0690c3535..fa28d61168 100644 --- a/locale/it_IT/LC_MESSAGES/changes/index.po +++ b/locale/it_IT/LC_MESSAGES/changes/index.po @@ -11,7 +11,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-09-28 00:48+0000\n" +"POT-Creation-Date: 2024-10-03 00:49+0000\n" "PO-Revision-Date: 2024-07-31 00:36+0000\n" "Last-Translator: 32e7d1c22f8d835b0e2261bd3e410b47_b6d0d5a <3e3890d708fef81118761bb1d0a44692_389909>, 2024\n" "Language-Team: Italian (Italy) (https://app.transifex.com/sphinx-doc/teams/15434/it_IT/)\n" @@ -238,11 +238,18 @@ msgid "" ":rst:dir:`py:module` directives. Patch by Stephen Finucane." msgstr "" -#: ../../sphinx/CHANGES.rst:112 +#: ../../sphinx/CHANGES.rst:110 +msgid "" +"#12916: Restore support for custom templates named with the legacy ``_t`` " +"suffix during ``apidoc`` RST rendering (regression in 7.4.0). Patch by James" +" Addison." +msgstr "" + +#: ../../sphinx/CHANGES.rst:115 msgid "Testing" msgstr "" -#: ../../sphinx/CHANGES.rst:114 +#: ../../sphinx/CHANGES.rst:117 msgid "" "#12141: Migrate from the deprecated ``karma`` JavaScript test framework to " "the actively-maintained ``jasmine`` framework. Test coverage is unaffected." diff --git a/locale/it_IT/LC_MESSAGES/extdev/deprecated.po b/locale/it_IT/LC_MESSAGES/extdev/deprecated.po index ad70808ad0..47d593ad8f 100644 --- a/locale/it_IT/LC_MESSAGES/extdev/deprecated.po +++ b/locale/it_IT/LC_MESSAGES/extdev/deprecated.po @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-09-02 00:47+0000\n" +"POT-Creation-Date: 2024-10-03 00:50+0000\n" "PO-Revision-Date: 2019-03-09 18:04+0000\n" "Language-Team: Italian (Italy) (https://app.transifex.com/sphinx-doc/teams/15434/it_IT/)\n" "MIME-Version: 1.0\n" @@ -2848,7 +2848,7 @@ msgid ":meth:`~sphinx.application.Sphinx.add_js_file`" msgstr "" #: ../../sphinx/doc/extdev/deprecated.rst:1457 -msgid ":confval:`autodoc_default_flags`" +msgid ":confval:`!autodoc_default_flags`" msgstr "" #: ../../sphinx/doc/extdev/deprecated.rst:1460 diff --git a/locale/it_IT/LC_MESSAGES/usage/domains/restructuredtext.po b/locale/it_IT/LC_MESSAGES/usage/domains/restructuredtext.po index facbcb4bf3..ecf4fc4316 100644 --- a/locale/it_IT/LC_MESSAGES/usage/domains/restructuredtext.po +++ b/locale/it_IT/LC_MESSAGES/usage/domains/restructuredtext.po @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-09-15 00:53+0000\n" +"POT-Creation-Date: 2024-10-03 00:49+0000\n" "PO-Revision-Date: 2023-10-03 00:37+0000\n" "Language-Team: Italian (Italy) (https://app.transifex.com/sphinx-doc/teams/15434/it_IT/)\n" "MIME-Version: 1.0\n" @@ -75,3 +75,20 @@ msgstr "" #: ../../sphinx/doc/usage/domains/restructuredtext.rst:97 msgid "These roles are provided to refer to the described objects:" msgstr "" + +#: ../../sphinx/doc/usage/domains/restructuredtext.rst:101 +msgid "Reference directives and directive options. Examples:" +msgstr "" + +#: ../../sphinx/doc/usage/domains/restructuredtext.rst:103 +msgid "Use ``:rst:dir:`my-directive``` to reference a directive." +msgstr "" + +#: ../../sphinx/doc/usage/domains/restructuredtext.rst:104 +msgid "" +"Use ``:rst:dir:`my-directive:my-option``` to reference a directive option." +msgstr "" + +#: ../../sphinx/doc/usage/domains/restructuredtext.rst:109 +msgid "Reference a role. Example: ``:rst:role:`my-role```." +msgstr "" diff --git a/locale/it_IT/LC_MESSAGES/usage/extensions/autodoc.po b/locale/it_IT/LC_MESSAGES/usage/extensions/autodoc.po index 369142e128..14566afec1 100644 --- a/locale/it_IT/LC_MESSAGES/usage/extensions/autodoc.po +++ b/locale/it_IT/LC_MESSAGES/usage/extensions/autodoc.po @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-10-02 00:49+0000\n" +"POT-Creation-Date: 2024-10-03 00:50+0000\n" "PO-Revision-Date: 2018-06-26 15:58+0000\n" "Language-Team: Italian (Italy) (https://app.transifex.com/sphinx-doc/teams/15434/it_IT/)\n" "MIME-Version: 1.0\n" @@ -21,26 +21,26 @@ msgstr "" msgid ":mod:`sphinx.ext.autodoc` -- Include documentation from docstrings" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:12 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:15 msgid "" "This extension can import the modules you are documenting, and pull in " "documentation from docstrings in a semi-automatic way." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:17 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:20 msgid "" ":mod:`~sphinx.ext.autodoc` **imports** the modules to be documented. If any " "modules have side effects on import, these will be executed by ``autodoc`` " "when :program:`sphinx-build` is run." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:21 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:24 msgid "" "If you document scripts (as opposed to library modules), make sure that the " "main routine is protected by an ``if __name__ == '__main__'`` condition." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:25 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:28 msgid "" "For this to work, the docstrings must of course be written in correct " "reStructuredText. You can then use all of the usual Sphinx markup in the " @@ -50,7 +50,7 @@ msgid "" "auto-generated-looking pure API documentation." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:33 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:36 msgid "" "If you prefer `NumPy`_ or `Google`_ style docstrings over reStructuredText, " "you can also enable the :mod:`napoleon ` extension. " @@ -58,25 +58,25 @@ msgid "" "reStructuredText before ``autodoc`` processes them." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:43 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:46 msgid "Getting started" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:47 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:50 msgid "Setup" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:49 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:52 msgid "" "Activate the plugin by adding ``'sphinx.ext.autodoc'`` to the " ":confval:`extensions` list in :file:`conf.py`:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:61 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:64 msgid "Ensuring the code can be imported" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:63 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:66 msgid "" ":mod:`~sphinx.ext.autodoc` analyses the code and docstrings by introspection" " after **importing the modules**. For importing to work, you have to make " @@ -86,11 +86,11 @@ msgid "" "fail)." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:70 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:73 msgid "There are two ways to ensure this:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:72 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:75 msgid "" "Use an environment that contains your package and Sphinx. This can e.g. be " "your local development environment (with an editable install), or an " @@ -99,14 +99,14 @@ msgid "" "that all dependencies are available." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:78 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:81 msgid "" "It is alternatively possible to patch the Sphinx run so that it can operate " "directly on the sources; e.g. if you want to be able to do a Sphinx build " "from a source checkout." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:82 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:85 msgid "" "Patch :data:`sys.path` in :file:`conf.py` to include your source path. For " "example if you have a repository structure with :file:`doc/conf.py` and your" @@ -114,17 +114,17 @@ msgid "" "your :file:`conf.py`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:94 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:97 msgid "" "To cope with missing dependencies, specify the missing modules in the " ":confval:`autodoc_mock_imports` setting." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:99 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:102 msgid "Usage" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:101 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:104 msgid "" "You can now use the :ref:`autodoc-directives` to add formatted documentation" " for Python code elements like functions, classes, modules, etc. For " @@ -132,48 +132,48 @@ msgid "" "docstring from the source file, you'd write:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:110 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:113 msgid "" "You can also document whole classes or even modules automatically, using " "member options for the auto directives, like:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:119 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:122 msgid "" "As a hint to autodoc extension, you can put a ``::`` separator between the " "module name and the object name to let autodoc know the correct module, if " "it is ambiguous:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:129 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:132 msgid "Marking objects as public or private" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:131 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:134 msgid "" "autodoc considers a member private if its docstring contains ``:meta " "private:`` in its :ref:`info-field-lists`. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:145 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:148 msgid "" "autodoc considers a member public if its docstring contains ``:meta " "public:`` in its :ref:`info-field-lists`, even if it starts with an " "underscore. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:160 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:163 msgid "" "autodoc considers a variable member does not have any default value if its " "docstring contains ``:meta hide-value:`` in its :ref:`info-field-lists`. " "Example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:174 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:177 msgid "Doc comments and docstrings" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:176 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:179 msgid "" "Python has no built-in support for docstrings for module data members or " "class attributes. To allow documenting these, ``autodoc`` recognises a " @@ -181,7 +181,7 @@ msgid "" " 'documentation comment'." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:181 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:184 msgid "" "These comments start with a colon and an optional space character, ``'#:'`` " "or ``'#: '``. To be recognised, the comments must appear either on the same " @@ -190,28 +190,28 @@ msgid "" "definition." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:188 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:191 msgid "" "For example, all three of the following variables have valid doc-comments:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:202 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:205 msgid "" "Alternatively, ``autodoc`` can recognise a docstring on the line immediately" " following the definition." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:205 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:208 msgid "" "In the the following class definition, all attributes have documentation " "recognised by ``autodoc``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:233 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:236 msgid "Directives" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:235 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:238 msgid "" ":mod:`autodoc` provides several directives that are versions of the usual " ":rst:dir:`py:module`, :rst:dir:`py:class` and so forth. On parsing time, " @@ -220,24 +220,24 @@ msgid "" ":rst:dir:`py:module`, :rst:dir:`py:class` etc. directive." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:244 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:247 msgid "" "Just as :rst:dir:`py:class` respects the current :rst:dir:`py:module`, " ":rst:dir:`autoclass` will also do so. Likewise, :rst:dir:`automethod` will " "respect the current :rst:dir:`py:class`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:250 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:253 msgid "Default directive options" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:252 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:255 msgid "" "To make any of the options described below the default, use the " ":confval:`autodoc_default_options` dictionary in :file:`conf.py`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:255 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:258 msgid "" "If using defaults for the ``:members:``, ``:exclude-members:``, ``:private-" "members:``, or ``:special-members:`` options, setting the option on a " @@ -246,111 +246,111 @@ msgid "" "(``+``), as follows:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:269 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:272 msgid "" "If using :confval:`autodoc_default_options`, the defaults can be disabled " "per-directive with the negated form, :samp:`:no-{option}:` as an option of " "the directive For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:281 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:284 msgid "Automatically document modules" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:285 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:288 msgid "" "Document a module. By default, the directive only inserts the docstring of " "the module itself:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:292 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:526 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:792 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:866 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:295 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:531 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:797 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:871 msgid "will produce source like this:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:300 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:534 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:303 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:539 msgid "" "The directive can also contain content of its own, which will be inserted " "into the resulting non-auto directive source after the docstring (but before" " any automatic member documentation)." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:304 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:538 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:878 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:307 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:543 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:883 msgid "" "Therefore, you can also mix automatic and non-automatic member " "documentation, as follows:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:317 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:567 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:844 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:894 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:320 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:572 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:849 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:899 msgid "Options" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:321 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:324 msgid "" "Do not generate an index entry for the documented module or any auto-" "documented members." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:329 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:332 msgid "" "Indicate platforms on which the module is available. This is identical to " ":rst:dir:`py:module`'s ``:platform:`` option." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:335 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:338 msgid "" "A sentence describing the module's purpose. This is identical to " ":rst:dir:`py:module`'s ``:synopsis:`` option." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:343 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:346 msgid "" "Mark a module as deprecated. This is identical to :rst:dir:`py:module`'s " "``:deprecated:`` option." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:351 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:354 msgid "Do not use ``__all__`` when analysing the module to document." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:356 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:600 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:359 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:605 msgid "Options for selecting members to document" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:360 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:363 msgid "Generate automatic documentation for all members of the target module:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:367 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:370 msgid "" "By default, ``autodoc`` only includes public members with a docstring or " ":ref:`doc-comment ` (``#:``). If ``__all__`` exists, it will be" -" used to define which members are public, unless the ``:ignore-module-all:``" -" option is set." +" used to define which members are public, unless the :rst:dir:`:ignore-" +"module-all: ` option is set." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:372 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:615 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:376 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:620 msgid "" "To only document certain members, an explicit comma-separated list may be " "used as the argument to ``:members:``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:383 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:626 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:387 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:631 msgid "Exclude the given names from the members to document. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:397 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:401 msgid "" "To prevent documentation of imported classes or functions, in an " ":rst:dir:`!automodule` directive with the ``members`` option set, only " @@ -358,198 +358,197 @@ msgid "" "name given to ``automodule`` will be documented." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:402 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:406 msgid "" "Set the ``imported-members`` option if you want to prevent this behavior and" " document all available members." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:405 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:409 msgid "" "Note that attributes from imported modules will not be documented, because " "attribute documentation is discovered by parsing the source file of the " "current module." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:414 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:418 msgid "" "Generate automatic documentation for members of the target module that don't" " have a docstring or doc-comment. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:427 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:431 msgid "" "Generate automatic documentation for private members of the target module. " "This includes names with a leading underscore (e.g. ``_private``) and those " "members explicitly marked as private with ``:meta private:``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:437 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:703 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:441 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:708 msgid "" "To only document certain private members, an explicit comma-separated list " "may be used as the argument to ``:private-members:``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:447 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:475 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:741 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:451 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:479 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:746 msgid "The option can now take a comma-separated list of arguments." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:453 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:457 msgid "" "Generate automatic documentation for special members of the target module, " -"also known as :ref:`\"dunder\" names `. This includes " -"all names enclosed with a double-underscore, e.g. ``__special__``:" +"also known as :ref:`'dunder' names `. This includes all" +" names enclosed with a double-underscore, e.g. ``__special__``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:464 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:730 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:468 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:735 msgid "" "To only document certain special members, an explicit comma-separated list " "may be used as the argument to ``:special-members:``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:479 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:745 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:483 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:750 msgid "Options for documented members" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:483 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:749 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:487 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:754 msgid "" "Choose the ordering of automatically documented members (default: " "``alphabetical``). This overrides the :confval:`autodoc_member_order` " "setting." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:487 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:491 msgid "``alphabetical``: Use simple alphabetical order." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:489 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:493 msgid "" "``groupwise``: Group by object type (class, function, etc), use alphabetical" " order within groups." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:492 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:496 msgid "" "``bysource``: Use the order of objects in the module's source. The " "``__all__`` variable can be used to override this order." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:496 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:762 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:980 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:500 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:767 msgid "" "Note that for source order, the module must be a Python module with the " "source code available." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:500 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:766 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:504 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:771 msgid "Support the ``'bysource'`` option." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:506 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:510 msgid "" -"Enable the ``:show-inheritance:`` option for all members of the module, if " -"``:members:`` is enabled." +"Enable the :rst:dir:`:show-inheritance: ` option" +" for all members of the module, if ``:members:`` is enabled." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:513 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:518 msgid "Automatically document classes or exceptions" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:518 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:523 msgid "" -"Document a class. For exception classes, prefer ``autoexception``. By " +"Document a class. For exception classes, prefer ``.. autoexception::``. By " "default, the directive only inserts the docstring of the class itself:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:551 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:828 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:556 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:833 msgid "Advanced usage" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:552 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:829 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:557 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:834 msgid "" "It is possible to override the signature for explicitly documented callable " "objects (functions, methods, classes) with the regular syntax that will " "override the signature gained from introspection:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:562 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:839 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:567 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:844 msgid "" "This is useful if the signature from the method is hidden by a decorator." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:571 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:898 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:576 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:903 msgid "" "Do not generate an index entry for the documented class or any auto-" "documented members." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:579 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:584 msgid "" "Select which docstring will be used for the main body of the directive. This" " overrides the global value of :confval:`autoclass_content`. The possible " "values are:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:583 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:588 msgid "" "``class``: Only use the class's docstring. The :meth:`!__init__` method can " "be separately documented using the ``:members:`` option or " ":rst:dir:`automethod`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:587 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:592 msgid "``init``: Only use the docstring of the :meth:`!__init__` method." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:589 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:594 msgid "" -"``both`` Use both, appending the docstring of the :meth:`!__init__` method " +"``both``: Use both, appending the docstring of the :meth:`!__init__` method " "to the class's docstring." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:593 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:598 msgid "" "If the :meth:`!__init__` method doesn't exist or has a blank docstring, " "``autodoc`` will attempt to use the :meth:`!__new__` method's docstring, if " "it exists and is not blank." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:604 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:609 msgid "Generate automatic documentation for all members of the target class:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:611 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:616 msgid "" "By default, ``autodoc`` only includes public members with a docstring or " ":ref:`doc-comment ` (``#:``) that are attributes of the target " "class (i.e. not inherited)." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:640 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:645 msgid "" "To generate automatic documentation for members inherited from base classes," " use the ``:inherited-members:`` option:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:649 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:654 msgid "" "This can be combined with the ``:undoc-members:`` option to generate " "automatic documentation for *all* available members of the class." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:652 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:657 msgid "" "The members of classes listed in the argument to ``:inherited-members:`` are" " excluded from the automatic documentation. This defaults to " @@ -558,105 +557,105 @@ msgid "" "as the argument." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:658 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:663 msgid "" "For example; If your class ``MyList`` is derived from ``list`` class and you" " don't want to document ``list.__len__()``, you should specify a option " "``:inherited-members: list`` to avoid special members of list class." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:664 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:669 msgid "" "Should any of the inherited members use a format other than reStructuredText" " for their docstrings, there may be markup warnings or errors." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:670 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:675 msgid "" "``:inherited-members:`` now takes the name of a base class to exclude as an " "argument." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:674 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:679 msgid "A comma separated list of base class names can be used." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:680 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:685 msgid "" "Generate automatic documentation for members of the target class that don't " "have a docstring or doc-comment. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:693 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:698 msgid "" "Generate automatic documentation for private members of the target class. " "This includes names with a leading underscore (e.g. ``_private``) and those " "members explicitly marked as private with ``:meta private:``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:713 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:718 msgid "The option can now take arguments." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:719 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:724 msgid "" "Generate automatic documentation for special members of the target class, " -"also known as :ref:`\"dunder\" names `. This includes " -"all names enclosed with a double-underscore, e.g. ``__special__``:" +"also known as :ref:`'dunder' names `. This includes all" +" names enclosed with a double-underscore, e.g. ``__special__``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:753 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:758 msgid "``'alphabetical'``: Use simple alphabetical order." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:755 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:760 msgid "" "``'groupwise'``: Group by object type (class, function, etc), use " "alphabetical order within groups." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:758 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:763 msgid "" "``'bysource'``: Use the order of objects in the module's source. The " "``__all__`` variable can be used to override this order." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:772 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:777 msgid "Insert the class's base classes after the class signature." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:778 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:783 msgid "Automatically document function-like objects" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:785 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:790 msgid "" "Document a function, method, property, or decorator. By default, the " "directive only inserts the docstring of the function itself:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:800 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:874 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:805 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:879 msgid "" "The directive can also contain content of its own, which will be inserted " "into the resulting non-auto directive source after the docstring." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:804 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:809 msgid "" "Therefore, you can also mix automatic and non-automatic documentation, as " "follows:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:813 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:818 msgid ":rst:dir:`autodecorator`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:815 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:820 msgid ":rst:dir:`autoproperty`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:820 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:825 msgid "" "If you document decorated functions or methods, keep in mind that " "``autodoc`` retrieves its docstrings by importing the module and inspecting " @@ -665,30 +664,30 @@ msgid "" "the original ``__doc__`` to the new function." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:848 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:853 msgid "Do not generate an index entry for the documented function." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:854 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:859 msgid "Automatically document attributes or data" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:859 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:864 msgid "" "Document a module level variable or constant ('data') or class attribute. By" " default, the directive only inserts the docstring of the variable itself:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:887 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:892 msgid "" ":rst:dir:`autodata` and :rst:dir:`autoattribute` can now extract docstrings." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:890 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:895 msgid "Doc-comments are now allowed on the same line of an assignment." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:908 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:913 msgid "" "By default, ``autodoc`` attempts to obtain the type annotation and value of " "the variable by introspection, displaying it after the variable's name. To " @@ -696,165 +695,225 @@ msgid "" "argument to ``annotation``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:914 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:919 msgid "" "For example, if the runtime value of ``FILE_MODE`` is ``0o755``, the " "displayed value will be ``493`` (as ``oct(493) == '0o755'``). This can be " "fixed by setting ``:annotation: = 0o755``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:918 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:923 msgid "" -"If ``annotation`` is used without arguments, no value or type hint will be " -"shown for the variable." +"If ``:annotation:`` is used without arguments, no value or type hint will be" +" shown for the variable." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:925 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:930 msgid "" -"To display the type hint of the variable without a value, use the ``no-" -"value`` option. If both the ``annotation`` and ``no-value`` options are " -"used, ``no-value`` has no effect." +"To display the type hint of the variable without a value, use the ``:no-" +"value:`` option. If both the ``:annotation:`` and ``:no-value:`` options are" +" used, ``:no-value:`` has no effect." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:932 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:937 msgid "Configuration" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:934 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:939 msgid "There are also config values that you can set:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:938 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:0 +msgid "Type" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:0 +msgid "Default" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:945 msgid "" "This value selects what content will be inserted into the main body of an " ":rst:dir:`autoclass` directive. The possible values are:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:941 -msgid "``\"class\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:948 +msgid "``'class'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:942 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:949 msgid "" -"Only the class' docstring is inserted. This is the default. You can still " -"document ``__init__`` as a separate method using :rst:dir:`automethod` or " -"the ``members`` option to :rst:dir:`autoclass`." +"Only the class' docstring is inserted. You can still document ``__init__`` " +"as a separate method using :rst:dir:`automethod` or the ``members`` option " +"to :rst:dir:`autoclass`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:945 -msgid "``\"both\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:952 +msgid "``'both'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:946 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:953 msgid "" "Both the class' and the ``__init__`` method's docstring are concatenated and" " inserted." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:948 -msgid "``\"init\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:955 +msgid "``'init'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:949 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:956 msgid "Only the ``__init__`` method's docstring is inserted." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:953 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:960 msgid "" "If the class has no ``__init__`` method or if the ``__init__`` method's " "docstring is empty, but the class has a ``__new__`` method's docstring, it " "is used instead." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:961 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:970 msgid "" "This value selects how the signature will be displayed for the class defined" " by :rst:dir:`autoclass` directive. The possible values are:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:964 -msgid "``\"mixed\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:973 +msgid "``'mixed'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:965 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:974 msgid "Display the signature with the class name." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:966 -msgid "``\"separated\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:975 +msgid "``'separated'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:967 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:976 msgid "Display the signature as a method." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:969 -msgid "The default is ``\"mixed\"``." -msgstr "" - -#: ../../sphinx/doc/usage/extensions/autodoc.rst:975 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:984 msgid "" -"This value selects if automatically documented members are sorted " -"alphabetical (value ``'alphabetical'``), by member type (value " -"``'groupwise'``) or by source order (value ``'bysource'``). The default is " -"alphabetical." +"Define the order in which :rst:dir:`automodule` and :rst:dir:`autoclass` " +"members are listed. Supported values are:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:984 -msgid "Support for ``'bysource'``." +#: ../../sphinx/doc/usage/extensions/autodoc.rst:987 +msgid "``'alphabetical'``: Use alphabetical order." msgstr "" #: ../../sphinx/doc/usage/extensions/autodoc.rst:989 +msgid "``'groupwise'``: order by member type. The order is:" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:991 +msgid "for modules, exceptions, classes, functions, data" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:992 +msgid "for classes: methods, then properties and attributes" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:994 +msgid "Members are ordered alphabetically within groups." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:996 msgid "" -"This value is a list of autodoc directive flags that should be automatically" -" applied to all autodoc directives. The supported flags are ``'members'``, " -"``'undoc-members'``, ``'private-members'``, ``'special-members'``, " -"``'inherited-members'``, ``'show-inheritance'``, ``'ignore-module-all'`` and" -" ``'exclude-members'``." +"``'bysource'``: Use the order in which the members appear in the source " +"code. This requires that the module must be a Python module with the source " +"code available." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:999 -msgid "Integrated into :confval:`autodoc_default_options`." +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1002 +msgid "Support for ``'bysource'``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1003 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1009 msgid "" "The default options for autodoc directives. They are applied to all autodoc" " directives automatically. It must be a dictionary which maps option names " "to the values. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1017 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1023 msgid "" "Setting ``None`` or ``True`` to the value is equivalent to giving only the " "option name to the directives." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1020 -msgid "" -"The supported options are ``'members'``, ``'member-order'``, ``'undoc-" -"members'``, ``'private-members'``, ``'special-members'``, ``'inherited-" -"members'``, ``'show-inheritance'``, ``'ignore-module-all'``, ``'imported-" -"members'``, ``'exclude-members'``, ``'class-doc-from'`` and ``'no-value'``." +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1026 +msgid "The supported options are:" msgstr "" #: ../../sphinx/doc/usage/extensions/autodoc.rst:1028 -msgid "Accepts ``True`` as a value." +msgid "``'members'``: See :rst:dir:`automodule:members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1029 +msgid "``'undoc-members'`` See :rst:dir:`automodule:undoc-members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1030 +msgid "``'private-members'``: See :rst:dir:`automodule:private-members`." msgstr "" #: ../../sphinx/doc/usage/extensions/autodoc.rst:1031 -msgid "Added ``'imported-members'``." +msgid "``'special-members'``: See :rst:dir:`automodule:special-members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1032 +msgid "``'inherited-members'``: See :rst:dir:`autoclass:inherited-members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1033 +msgid "``'imported-members'``: See :rst:dir:`automodule:imported-members`." msgstr "" #: ../../sphinx/doc/usage/extensions/autodoc.rst:1034 -msgid "Added ``'class-doc-from'``." +msgid "``'exclude-members'``: See :rst:dir:`automodule:exclude-members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1035 +msgid "``'ignore-module-all'``: See :rst:dir:`automodule:ignore-module-all`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1036 +msgid "``'member-order'``: See :rst:dir:`automodule:member-order`." msgstr "" #: ../../sphinx/doc/usage/extensions/autodoc.rst:1037 +msgid "``'show-inheritance'``: See :rst:dir:`autoclass:show-inheritance`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1038 +msgid "``'class-doc-from'``: See :rst:dir:`autoclass:class-doc-from`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1039 +msgid "``'no-value'``: See :rst:dir:`autodata:no-value`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1043 +msgid "Accepts ``True`` as a value." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1046 +msgid "Added ``'imported-members'``." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1049 +msgid "Added ``'class-doc-from'``." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1052 msgid "Added ``'no-value'``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1042 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1059 msgid "" "Functions imported from C modules cannot be introspected, and therefore the " "signature for such functions cannot be automatically determined. However, " @@ -862,7 +921,7 @@ msgid "" "the function's docstring." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1047 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1064 msgid "" "If this boolean value is set to ``True`` (which is the default), autodoc " "will look at the first line of the docstring for functions and methods, and " @@ -870,22 +929,22 @@ msgid "" "from the docstring content." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1052 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1069 msgid "" "autodoc will continue to look for multiple signature lines, stopping at the " "first line that does not look like a signature. This is useful for declaring" " overloaded function signatures." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1059 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1076 msgid "Support overloaded signatures" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1063 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1080 msgid "Overloaded signatures do not need to be separated by a backslash" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1067 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1086 msgid "" "This value contains a list of modules to be mocked up. This is useful when " "some external dependencies are not met at build time and break the building " @@ -893,198 +952,194 @@ msgid "" "themselves and omit the sub-modules:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1076 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1095 msgid "Will mock all imports under the ``django`` package." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1080 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1099 msgid "" "This config value only requires to declare the top-level modules that should" " be mocked." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1086 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1107 msgid "" "This value controls how to represent typehints. The setting takes the " "following values:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1089 -msgid "``'signature'`` -- Show typehints in the signature (default)" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1110 +msgid "``'signature'`` -- Show typehints in the signature" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1090 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1111 msgid "" "``'description'`` -- Show typehints as content of the function or method The" " typehints of overloaded functions or methods will still be represented in " "the signature." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1093 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1114 msgid "``'none'`` -- Do not show typehints" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1094 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1115 msgid "" "``'both'`` -- Show typehints in the signature and as content of the function" " or method" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1097 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1118 msgid "" "Overloaded functions or methods will not have typehints included in the " "description because it is impossible to accurately represent all possible " "overloads as a list of parameters." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1104 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1125 msgid "New option ``'description'`` is added." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1108 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1129 msgid "New option ``'both'`` is added." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1112 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1135 msgid "" "This value controls whether the types of undocumented parameters and return " -"values are documented when ``autodoc_typehints`` is set to ``description``." +"values are documented when :confval:`autodoc_typehints` is set to " +"``'description'``. Supported values:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1115 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1140 msgid "" -"The default value is ``\"all\"``, meaning that types are documented for all " -"parameters and return values, whether they are documented or not." +"``'all'``: Types are documented for all parameters and return values, " +"whether they are documented or not." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1118 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1143 msgid "" -"When set to ``\"documented\"``, types will only be documented for a " -"parameter or a return value that is already documented by the docstring." +"``'documented'``: Types will only be documented for a parameter or a return " +"value that is already documented by the docstring." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1121 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1146 msgid "" -"With ``\"documented_params\"``, parameter types will only be annotated if " -"the parameter is documented in the docstring. The return type is always " +"``'documented_params'``: Parameter types will only be annotated if the " +"parameter is documented in the docstring. The return type is always " "annotated (except if it is ``None``)." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1129 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1155 msgid "New option ``'documented_params'`` is added." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1133 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1161 msgid "" "A dictionary for users defined `type aliases`__ that maps a type name to the" " full-qualified object name. It is used to keep type aliases not evaluated " -"in the document. Defaults to empty (``{}``)." +"in the document." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1137 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1165 msgid "" "The type aliases are only available if your program enables :pep:`Postponed " "Evaluation of Annotations (PEP 563) <563>` feature via ``from __future__ " "import annotations``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1141 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1169 msgid "For example, there is code using a type alias:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1152 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1180 msgid "" "If ``autodoc_type_aliases`` is not set, autodoc will generate internal mark-" "up from this code as following:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1161 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1189 msgid "" "If you set ``autodoc_type_aliases`` as ``{'AliasType': " "'your.module.AliasType'}``, it generates the following document internally:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1176 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1206 msgid "" "This value controls the format of typehints. The setting takes the " "following values:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1179 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1209 msgid "" "``'fully-qualified'`` -- Show the module name and its name of typehints" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1180 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1210 msgid "" "``'short'`` -- Suppress the leading module names of the typehints (e.g. " -"``io.StringIO`` -> ``StringIO``) (default)" +"``io.StringIO`` -> ``StringIO``)" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1187 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1217 msgid "The default setting was changed to ``'short'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1191 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1223 msgid "" "If True, the default argument values of functions will be not evaluated on " "generating document. It preserves them as is in the source code." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1196 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1228 msgid "" "Added as an experimental feature. This will be integrated into autodoc core" " in the future." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1201 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1235 msgid "" "This value controls the behavior of :option:`sphinx-build --fail-on-warning`" " during importing modules. If ``False`` is given, autodoc forcedly " -"suppresses the error if the imported module emits warnings. By default, " -"``True``." +"suppresses the error if the imported module emits warnings." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1206 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1240 msgid "" "This option now has no effect as :option:`!--fail-on-warning` no longer " "exits early." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1212 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1248 msgid "" "This value controls the docstrings inheritance. If set to True the docstring" " for classes or methods, if not explicitly set, is inherited from parents." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1216 -msgid "The default is ``True``." -msgstr "" - -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1223 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1259 msgid "" -":mod:`autodoc` supports to suppress warning messages via " -":confval:`suppress_warnings`. It allows following warnings types in " -"addition:" +":mod:`autodoc` supports suppressing warning messages via " +":confval:`suppress_warnings`. It defines the following additional warnings " +"types:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1227 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1263 msgid "autodoc" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1228 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1264 msgid "autodoc.import_object" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1232 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1268 msgid "Docstring preprocessing" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1234 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1270 msgid "autodoc provides the following additional events:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1240 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1276 msgid "" "Emitted when autodoc has read and processed a docstring. *lines* is a list " "of strings -- the lines of the processed docstring -- that the event handler" @@ -1095,41 +1150,40 @@ msgstr "" msgid "Parameters" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1244 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1263 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1275 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1304 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1336 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1280 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1299 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1311 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1340 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1372 msgid "the Sphinx application object" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1245 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1276 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1337 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1281 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1312 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1373 msgid "" -"the type of the object which the docstring belongs to (one of " -"``\"module\"``, ``\"class\"``, ``\"exception\"``, ``\"function\"``, " -"``\"method\"``, ``\"attribute\"``)" +"the type of the object which the docstring belongs to (one of ``'module'``, " +"``'class'``, ``'exception'``, ``'function'``, ``'method'``, ``'attribute'``)" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1248 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1279 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1305 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1340 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1284 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1315 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1341 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1376 msgid "the fully qualified name of the object" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1249 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1264 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1280 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1306 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1341 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1285 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1300 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1316 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1342 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1377 msgid "the object itself" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1250 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1281 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1344 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1286 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1317 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1380 msgid "" "the options given to the directive: an object with attributes " "``inherited_members``, ``undoc_members``, ``show_inheritance`` and ``no-" @@ -1137,41 +1191,41 @@ msgid "" "directive" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1254 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1290 msgid "the lines of the docstring, see above" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1260 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1296 msgid "" "Emitted before autodoc formats a signature for an object. The event handler " "can modify an object to change its signature." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1265 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1301 msgid "a boolean indicates an object is bound method or not" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1271 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1307 msgid "" "Emitted when autodoc has formatted a signature for an object. The event " "handler can return a new tuple ``(signature, return_annotation)`` to change " "what Sphinx puts into the output." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1285 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1321 msgid "" -"function signature, as a string of the form ``\"(parameter_1, " -"parameter_2)\"``, or ``None`` if introspection didn't succeed and signature " +"function signature, as a string of the form ``'(parameter_1, " +"parameter_2)'``, or ``None`` if introspection didn't succeed and signature " "wasn't specified in the directive." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1288 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1324 msgid "" -"function return annotation as a string of the form ``\" -> annotation\"``, " -"or ``None`` if there is no return annotation" +"function return annotation as a string of the form ``' -> annotation'``, or " +"``None`` if there is no return annotation" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1291 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1327 msgid "" "The :mod:`sphinx.ext.autodoc` module provides factory functions for commonly" " needed docstring processing in event :event:`autodoc-process-docstring`:" @@ -1212,7 +1266,7 @@ msgid "" " be processed." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1299 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1335 msgid "" "Emitted when autodoc has read and processed a class to determine the base-" "classes. *bases* is a list of classes that the event handler can modify " @@ -1220,38 +1274,38 @@ msgid "" "if ``show-inheritance`` option given." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1307 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1343 msgid "the options given to the class directive" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1308 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1344 msgid "the list of base classes signature. see above." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1313 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1349 msgid "" "``bases`` can contain a string as a base class name. It will be processed as" " reStructuredText." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1318 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1354 msgid "Skipping members" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1320 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1356 msgid "" "autodoc allows the user to define a custom method for determining whether a " "member should be included in the documentation by using the following event:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1327 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1363 msgid "" "Emitted when autodoc has to decide whether a member should be included in " "the documentation. The member is excluded if a handler returns ``True``. " "It is included if the handler returns ``False``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1331 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1367 msgid "" "If more than one enabled extension handles the ``autodoc-skip-member`` " "event, autodoc will use the first non-``None`` value returned by a handler. " @@ -1259,7 +1313,7 @@ msgid "" "autodoc and other enabled extensions." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1342 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1378 msgid "" "a boolean indicating if autodoc will skip this member if the user handler " "does not override the decision" diff --git a/locale/ja/LC_MESSAGES/changes/1.8.po b/locale/ja/LC_MESSAGES/changes/1.8.po index 542712f937..2672acae18 100644 --- a/locale/ja/LC_MESSAGES/changes/1.8.po +++ b/locale/ja/LC_MESSAGES/changes/1.8.po @@ -13,7 +13,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-10-01 00:54+0000\n" +"POT-Creation-Date: 2024-10-03 00:49+0000\n" "PO-Revision-Date: 2024-07-31 00:36+0000\n" "Last-Translator: Takayuki SHIMIZUKAWA , 2024\n" "Language-Team: Japanese (https://app.transifex.com/sphinx-doc/teams/15434/ja/)\n" @@ -402,7 +402,7 @@ msgstr "" #: ../../sphinx/doc/changes/1.8.rst:150 msgid "" "#5421: autodoc emits deprecation warning for " -":confval:`autodoc_default_flags`" +":confval:`!autodoc_default_flags`" msgstr "" #: ../../sphinx/doc/changes/1.8.rst:151 @@ -670,7 +670,7 @@ msgid ":confval:`!source_parsers` is deprecated" msgstr "" #: ../../sphinx/doc/changes/1.8.rst:254 -msgid ":confval:`autodoc_default_flags` is deprecated" +msgid ":confval:`!autodoc_default_flags` is deprecated" msgstr "" #: ../../sphinx/doc/changes/1.8.rst:255 diff --git a/locale/ja/LC_MESSAGES/changes/index.po b/locale/ja/LC_MESSAGES/changes/index.po index 43812e1654..07eae89c13 100644 --- a/locale/ja/LC_MESSAGES/changes/index.po +++ b/locale/ja/LC_MESSAGES/changes/index.po @@ -13,7 +13,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-09-28 00:48+0000\n" +"POT-Creation-Date: 2024-10-03 00:49+0000\n" "PO-Revision-Date: 2024-07-31 00:36+0000\n" "Last-Translator: Takayuki SHIMIZUKAWA , 2024\n" "Language-Team: Japanese (https://app.transifex.com/sphinx-doc/teams/15434/ja/)\n" @@ -240,11 +240,18 @@ msgid "" ":rst:dir:`py:module` directives. Patch by Stephen Finucane." msgstr "" -#: ../../sphinx/CHANGES.rst:112 +#: ../../sphinx/CHANGES.rst:110 +msgid "" +"#12916: Restore support for custom templates named with the legacy ``_t`` " +"suffix during ``apidoc`` RST rendering (regression in 7.4.0). Patch by James" +" Addison." +msgstr "" + +#: ../../sphinx/CHANGES.rst:115 msgid "Testing" msgstr "" -#: ../../sphinx/CHANGES.rst:114 +#: ../../sphinx/CHANGES.rst:117 msgid "" "#12141: Migrate from the deprecated ``karma`` JavaScript test framework to " "the actively-maintained ``jasmine`` framework. Test coverage is unaffected." diff --git a/locale/ja/LC_MESSAGES/extdev/deprecated.po b/locale/ja/LC_MESSAGES/extdev/deprecated.po index c0b71ba715..bc3fb8dbaa 100644 --- a/locale/ja/LC_MESSAGES/extdev/deprecated.po +++ b/locale/ja/LC_MESSAGES/extdev/deprecated.po @@ -12,7 +12,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-09-02 00:47+0000\n" +"POT-Creation-Date: 2024-10-03 00:50+0000\n" "PO-Revision-Date: 2019-03-09 18:04+0000\n" "Last-Translator: Komiya Takeshi , 2021\n" "Language-Team: Japanese (https://app.transifex.com/sphinx-doc/teams/15434/ja/)\n" @@ -2853,8 +2853,8 @@ msgid ":meth:`~sphinx.application.Sphinx.add_js_file`" msgstr "" #: ../../sphinx/doc/extdev/deprecated.rst:1457 -msgid ":confval:`autodoc_default_flags`" -msgstr ":confval:`autodoc_default_flags`" +msgid ":confval:`!autodoc_default_flags`" +msgstr "" #: ../../sphinx/doc/extdev/deprecated.rst:1460 msgid ":confval:`autodoc_default_options`" diff --git a/locale/ja/LC_MESSAGES/usage/domains/restructuredtext.po b/locale/ja/LC_MESSAGES/usage/domains/restructuredtext.po index 09aa9ac02b..418391dfac 100644 --- a/locale/ja/LC_MESSAGES/usage/domains/restructuredtext.po +++ b/locale/ja/LC_MESSAGES/usage/domains/restructuredtext.po @@ -11,7 +11,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-09-15 00:53+0000\n" +"POT-Creation-Date: 2024-10-03 00:49+0000\n" "PO-Revision-Date: 2023-10-03 00:37+0000\n" "Last-Translator: Takayuki SHIMIZUKAWA , 2023\n" "Language-Team: Japanese (https://app.transifex.com/sphinx-doc/teams/15434/ja/)\n" @@ -79,3 +79,20 @@ msgstr "" #: ../../sphinx/doc/usage/domains/restructuredtext.rst:97 msgid "These roles are provided to refer to the described objects:" msgstr "このドメインでは、オブジェクトの説明を参照する、次のようなロールが提供されています:" + +#: ../../sphinx/doc/usage/domains/restructuredtext.rst:101 +msgid "Reference directives and directive options. Examples:" +msgstr "" + +#: ../../sphinx/doc/usage/domains/restructuredtext.rst:103 +msgid "Use ``:rst:dir:`my-directive``` to reference a directive." +msgstr "" + +#: ../../sphinx/doc/usage/domains/restructuredtext.rst:104 +msgid "" +"Use ``:rst:dir:`my-directive:my-option``` to reference a directive option." +msgstr "" + +#: ../../sphinx/doc/usage/domains/restructuredtext.rst:109 +msgid "Reference a role. Example: ``:rst:role:`my-role```." +msgstr "" diff --git a/locale/ja/LC_MESSAGES/usage/extensions/autodoc.po b/locale/ja/LC_MESSAGES/usage/extensions/autodoc.po index 41b9c0e115..3d29306615 100644 --- a/locale/ja/LC_MESSAGES/usage/extensions/autodoc.po +++ b/locale/ja/LC_MESSAGES/usage/extensions/autodoc.po @@ -17,7 +17,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-10-02 00:49+0000\n" +"POT-Creation-Date: 2024-10-03 00:50+0000\n" "PO-Revision-Date: 2018-06-26 15:58+0000\n" "Last-Translator: Takayuki SHIMIZUKAWA , 2024\n" "Language-Team: Japanese (https://app.transifex.com/sphinx-doc/teams/15434/ja/)\n" @@ -31,27 +31,27 @@ msgstr "" msgid ":mod:`sphinx.ext.autodoc` -- Include documentation from docstrings" msgstr ":mod:`sphinx.ext.autodoc` -- docstringからのドキュメントの取り込み" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:12 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:15 msgid "" "This extension can import the modules you are documenting, and pull in " "documentation from docstrings in a semi-automatic way." msgstr "" "この拡張機能は、docstringでドキュメントが書かれているモジュールをインポートして、そのdocstringから、半自動的にドキュメントを取り込みます。" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:17 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:20 msgid "" ":mod:`~sphinx.ext.autodoc` **imports** the modules to be documented. If any " "modules have side effects on import, these will be executed by ``autodoc`` " "when :program:`sphinx-build` is run." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:21 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:24 msgid "" "If you document scripts (as opposed to library modules), make sure that the " "main routine is protected by an ``if __name__ == '__main__'`` condition." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:25 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:28 msgid "" "For this to work, the docstrings must of course be written in correct " "reStructuredText. You can then use all of the usual Sphinx markup in the " @@ -61,7 +61,7 @@ msgid "" "auto-generated-looking pure API documentation." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:33 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:36 msgid "" "If you prefer `NumPy`_ or `Google`_ style docstrings over reStructuredText, " "you can also enable the :mod:`napoleon ` extension. " @@ -69,25 +69,25 @@ msgid "" "reStructuredText before ``autodoc`` processes them." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:43 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:46 msgid "Getting started" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:47 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:50 msgid "Setup" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:49 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:52 msgid "" "Activate the plugin by adding ``'sphinx.ext.autodoc'`` to the " ":confval:`extensions` list in :file:`conf.py`:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:61 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:64 msgid "Ensuring the code can be imported" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:63 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:66 msgid "" ":mod:`~sphinx.ext.autodoc` analyses the code and docstrings by introspection" " after **importing the modules**. For importing to work, you have to make " @@ -97,11 +97,11 @@ msgid "" "fail)." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:70 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:73 msgid "There are two ways to ensure this:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:72 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:75 msgid "" "Use an environment that contains your package and Sphinx. This can e.g. be " "your local development environment (with an editable install), or an " @@ -110,14 +110,14 @@ msgid "" "that all dependencies are available." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:78 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:81 msgid "" "It is alternatively possible to patch the Sphinx run so that it can operate " "directly on the sources; e.g. if you want to be able to do a Sphinx build " "from a source checkout." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:82 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:85 msgid "" "Patch :data:`sys.path` in :file:`conf.py` to include your source path. For " "example if you have a repository structure with :file:`doc/conf.py` and your" @@ -125,17 +125,17 @@ msgid "" "your :file:`conf.py`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:94 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:97 msgid "" "To cope with missing dependencies, specify the missing modules in the " ":confval:`autodoc_mock_imports` setting." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:99 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:102 msgid "Usage" msgstr "使用方法" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:101 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:104 msgid "" "You can now use the :ref:`autodoc-directives` to add formatted documentation" " for Python code elements like functions, classes, modules, etc. For " @@ -143,48 +143,48 @@ msgid "" "docstring from the source file, you'd write:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:110 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:113 msgid "" "You can also document whole classes or even modules automatically, using " "member options for the auto directives, like:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:119 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:122 msgid "" "As a hint to autodoc extension, you can put a ``::`` separator between the " "module name and the object name to let autodoc know the correct module, if " "it is ambiguous:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:129 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:132 msgid "Marking objects as public or private" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:131 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:134 msgid "" "autodoc considers a member private if its docstring contains ``:meta " "private:`` in its :ref:`info-field-lists`. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:145 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:148 msgid "" "autodoc considers a member public if its docstring contains ``:meta " "public:`` in its :ref:`info-field-lists`, even if it starts with an " "underscore. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:160 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:163 msgid "" "autodoc considers a variable member does not have any default value if its " "docstring contains ``:meta hide-value:`` in its :ref:`info-field-lists`. " "Example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:174 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:177 msgid "Doc comments and docstrings" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:176 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:179 msgid "" "Python has no built-in support for docstrings for module data members or " "class attributes. To allow documenting these, ``autodoc`` recognises a " @@ -192,7 +192,7 @@ msgid "" " 'documentation comment'." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:181 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:184 msgid "" "These comments start with a colon and an optional space character, ``'#:'`` " "or ``'#: '``. To be recognised, the comments must appear either on the same " @@ -201,28 +201,28 @@ msgid "" "definition." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:188 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:191 msgid "" "For example, all three of the following variables have valid doc-comments:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:202 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:205 msgid "" "Alternatively, ``autodoc`` can recognise a docstring on the line immediately" " following the definition." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:205 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:208 msgid "" "In the the following class definition, all attributes have documentation " "recognised by ``autodoc``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:233 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:236 msgid "Directives" msgstr "ディレクティブ" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:235 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:238 msgid "" ":mod:`autodoc` provides several directives that are versions of the usual " ":rst:dir:`py:module`, :rst:dir:`py:class` and so forth. On parsing time, " @@ -231,24 +231,24 @@ msgid "" ":rst:dir:`py:module`, :rst:dir:`py:class` etc. directive." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:244 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:247 msgid "" "Just as :rst:dir:`py:class` respects the current :rst:dir:`py:module`, " ":rst:dir:`autoclass` will also do so. Likewise, :rst:dir:`automethod` will " "respect the current :rst:dir:`py:class`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:250 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:253 msgid "Default directive options" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:252 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:255 msgid "" "To make any of the options described below the default, use the " ":confval:`autodoc_default_options` dictionary in :file:`conf.py`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:255 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:258 msgid "" "If using defaults for the ``:members:``, ``:exclude-members:``, ``:private-" "members:``, or ``:special-members:`` options, setting the option on a " @@ -257,111 +257,111 @@ msgid "" "(``+``), as follows:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:269 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:272 msgid "" "If using :confval:`autodoc_default_options`, the defaults can be disabled " "per-directive with the negated form, :samp:`:no-{option}:` as an option of " "the directive For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:281 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:284 msgid "Automatically document modules" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:285 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:288 msgid "" "Document a module. By default, the directive only inserts the docstring of " "the module itself:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:292 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:526 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:792 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:866 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:295 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:531 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:797 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:871 msgid "will produce source like this:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:300 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:534 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:303 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:539 msgid "" "The directive can also contain content of its own, which will be inserted " "into the resulting non-auto directive source after the docstring (but before" " any automatic member documentation)." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:304 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:538 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:878 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:307 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:543 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:883 msgid "" "Therefore, you can also mix automatic and non-automatic member " "documentation, as follows:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:317 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:567 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:844 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:894 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:320 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:572 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:849 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:899 msgid "Options" msgstr "オプション" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:321 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:324 msgid "" "Do not generate an index entry for the documented module or any auto-" "documented members." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:329 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:332 msgid "" "Indicate platforms on which the module is available. This is identical to " ":rst:dir:`py:module`'s ``:platform:`` option." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:335 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:338 msgid "" "A sentence describing the module's purpose. This is identical to " ":rst:dir:`py:module`'s ``:synopsis:`` option." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:343 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:346 msgid "" "Mark a module as deprecated. This is identical to :rst:dir:`py:module`'s " "``:deprecated:`` option." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:351 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:354 msgid "Do not use ``__all__`` when analysing the module to document." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:356 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:600 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:359 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:605 msgid "Options for selecting members to document" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:360 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:363 msgid "Generate automatic documentation for all members of the target module:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:367 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:370 msgid "" "By default, ``autodoc`` only includes public members with a docstring or " ":ref:`doc-comment ` (``#:``). If ``__all__`` exists, it will be" -" used to define which members are public, unless the ``:ignore-module-all:``" -" option is set." +" used to define which members are public, unless the :rst:dir:`:ignore-" +"module-all: ` option is set." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:372 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:615 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:376 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:620 msgid "" "To only document certain members, an explicit comma-separated list may be " "used as the argument to ``:members:``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:383 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:626 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:387 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:631 msgid "Exclude the given names from the members to document. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:397 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:401 msgid "" "To prevent documentation of imported classes or functions, in an " ":rst:dir:`!automodule` directive with the ``members`` option set, only " @@ -369,199 +369,198 @@ msgid "" "name given to ``automodule`` will be documented." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:402 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:406 msgid "" "Set the ``imported-members`` option if you want to prevent this behavior and" " document all available members." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:405 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:409 msgid "" "Note that attributes from imported modules will not be documented, because " "attribute documentation is discovered by parsing the source file of the " "current module." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:414 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:418 msgid "" "Generate automatic documentation for members of the target module that don't" " have a docstring or doc-comment. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:427 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:431 msgid "" "Generate automatic documentation for private members of the target module. " "This includes names with a leading underscore (e.g. ``_private``) and those " "members explicitly marked as private with ``:meta private:``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:437 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:703 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:441 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:708 msgid "" "To only document certain private members, an explicit comma-separated list " "may be used as the argument to ``:private-members:``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:447 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:475 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:741 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:451 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:479 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:746 msgid "The option can now take a comma-separated list of arguments." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:453 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:457 msgid "" "Generate automatic documentation for special members of the target module, " -"also known as :ref:`\"dunder\" names `. This includes " -"all names enclosed with a double-underscore, e.g. ``__special__``:" +"also known as :ref:`'dunder' names `. This includes all" +" names enclosed with a double-underscore, e.g. ``__special__``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:464 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:730 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:468 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:735 msgid "" "To only document certain special members, an explicit comma-separated list " "may be used as the argument to ``:special-members:``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:479 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:745 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:483 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:750 msgid "Options for documented members" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:483 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:749 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:487 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:754 msgid "" "Choose the ordering of automatically documented members (default: " "``alphabetical``). This overrides the :confval:`autodoc_member_order` " "setting." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:487 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:491 msgid "``alphabetical``: Use simple alphabetical order." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:489 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:493 msgid "" "``groupwise``: Group by object type (class, function, etc), use alphabetical" " order within groups." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:492 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:496 msgid "" "``bysource``: Use the order of objects in the module's source. The " "``__all__`` variable can be used to override this order." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:496 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:762 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:980 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:500 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:767 msgid "" "Note that for source order, the module must be a Python module with the " "source code available." msgstr "" "ソースコードの定義順を指定する場合には、対象のモジュールはPythonモジュールで、ソースコードが利用できるようになっていなければなりません。" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:500 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:766 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:504 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:771 msgid "Support the ``'bysource'`` option." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:506 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:510 msgid "" -"Enable the ``:show-inheritance:`` option for all members of the module, if " -"``:members:`` is enabled." +"Enable the :rst:dir:`:show-inheritance: ` option" +" for all members of the module, if ``:members:`` is enabled." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:513 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:518 msgid "Automatically document classes or exceptions" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:518 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:523 msgid "" -"Document a class. For exception classes, prefer ``autoexception``. By " +"Document a class. For exception classes, prefer ``.. autoexception::``. By " "default, the directive only inserts the docstring of the class itself:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:551 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:828 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:556 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:833 msgid "Advanced usage" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:552 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:829 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:557 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:834 msgid "" "It is possible to override the signature for explicitly documented callable " "objects (functions, methods, classes) with the regular syntax that will " "override the signature gained from introspection:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:562 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:839 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:567 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:844 msgid "" "This is useful if the signature from the method is hidden by a decorator." msgstr "この機能はデコレータなどによって、メソッドの呼び出し規約が内省機能で取れない状態になっている場合に便利です。" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:571 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:898 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:576 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:903 msgid "" "Do not generate an index entry for the documented class or any auto-" "documented members." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:579 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:584 msgid "" "Select which docstring will be used for the main body of the directive. This" " overrides the global value of :confval:`autoclass_content`. The possible " "values are:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:583 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:588 msgid "" "``class``: Only use the class's docstring. The :meth:`!__init__` method can " "be separately documented using the ``:members:`` option or " ":rst:dir:`automethod`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:587 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:592 msgid "``init``: Only use the docstring of the :meth:`!__init__` method." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:589 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:594 msgid "" -"``both`` Use both, appending the docstring of the :meth:`!__init__` method " +"``both``: Use both, appending the docstring of the :meth:`!__init__` method " "to the class's docstring." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:593 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:598 msgid "" "If the :meth:`!__init__` method doesn't exist or has a blank docstring, " "``autodoc`` will attempt to use the :meth:`!__new__` method's docstring, if " "it exists and is not blank." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:604 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:609 msgid "Generate automatic documentation for all members of the target class:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:611 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:616 msgid "" "By default, ``autodoc`` only includes public members with a docstring or " ":ref:`doc-comment ` (``#:``) that are attributes of the target " "class (i.e. not inherited)." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:640 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:645 msgid "" "To generate automatic documentation for members inherited from base classes," " use the ``:inherited-members:`` option:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:649 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:654 msgid "" "This can be combined with the ``:undoc-members:`` option to generate " "automatic documentation for *all* available members of the class." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:652 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:657 msgid "" "The members of classes listed in the argument to ``:inherited-members:`` are" " excluded from the automatic documentation. This defaults to " @@ -570,105 +569,105 @@ msgid "" "as the argument." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:658 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:663 msgid "" "For example; If your class ``MyList`` is derived from ``list`` class and you" " don't want to document ``list.__len__()``, you should specify a option " "``:inherited-members: list`` to avoid special members of list class." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:664 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:669 msgid "" "Should any of the inherited members use a format other than reStructuredText" " for their docstrings, there may be markup warnings or errors." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:670 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:675 msgid "" "``:inherited-members:`` now takes the name of a base class to exclude as an " "argument." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:674 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:679 msgid "A comma separated list of base class names can be used." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:680 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:685 msgid "" "Generate automatic documentation for members of the target class that don't " "have a docstring or doc-comment. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:693 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:698 msgid "" "Generate automatic documentation for private members of the target class. " "This includes names with a leading underscore (e.g. ``_private``) and those " "members explicitly marked as private with ``:meta private:``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:713 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:718 msgid "The option can now take arguments." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:719 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:724 msgid "" "Generate automatic documentation for special members of the target class, " -"also known as :ref:`\"dunder\" names `. This includes " -"all names enclosed with a double-underscore, e.g. ``__special__``:" +"also known as :ref:`'dunder' names `. This includes all" +" names enclosed with a double-underscore, e.g. ``__special__``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:753 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:758 msgid "``'alphabetical'``: Use simple alphabetical order." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:755 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:760 msgid "" "``'groupwise'``: Group by object type (class, function, etc), use " "alphabetical order within groups." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:758 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:763 msgid "" "``'bysource'``: Use the order of objects in the module's source. The " "``__all__`` variable can be used to override this order." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:772 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:777 msgid "Insert the class's base classes after the class signature." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:778 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:783 msgid "Automatically document function-like objects" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:785 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:790 msgid "" "Document a function, method, property, or decorator. By default, the " "directive only inserts the docstring of the function itself:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:800 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:874 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:805 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:879 msgid "" "The directive can also contain content of its own, which will be inserted " "into the resulting non-auto directive source after the docstring." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:804 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:809 msgid "" "Therefore, you can also mix automatic and non-automatic documentation, as " "follows:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:813 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:818 msgid ":rst:dir:`autodecorator`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:815 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:820 msgid ":rst:dir:`autoproperty`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:820 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:825 msgid "" "If you document decorated functions or methods, keep in mind that " "``autodoc`` retrieves its docstrings by importing the module and inspecting " @@ -677,30 +676,30 @@ msgid "" "the original ``__doc__`` to the new function." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:848 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:853 msgid "Do not generate an index entry for the documented function." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:854 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:859 msgid "Automatically document attributes or data" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:859 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:864 msgid "" "Document a module level variable or constant ('data') or class attribute. By" " default, the directive only inserts the docstring of the variable itself:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:887 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:892 msgid "" ":rst:dir:`autodata` and :rst:dir:`autoattribute` can now extract docstrings." msgstr ":rst:dir:`autodata` と :rst:dir:`autoattribute` がdocstringにも対応しました。" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:890 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:895 msgid "Doc-comments are now allowed on the same line of an assignment." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:908 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:913 msgid "" "By default, ``autodoc`` attempts to obtain the type annotation and value of " "the variable by introspection, displaying it after the variable's name. To " @@ -708,35 +707,43 @@ msgid "" "argument to ``annotation``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:914 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:919 msgid "" "For example, if the runtime value of ``FILE_MODE`` is ``0o755``, the " "displayed value will be ``493`` (as ``oct(493) == '0o755'``). This can be " "fixed by setting ``:annotation: = 0o755``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:918 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:923 msgid "" -"If ``annotation`` is used without arguments, no value or type hint will be " -"shown for the variable." +"If ``:annotation:`` is used without arguments, no value or type hint will be" +" shown for the variable." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:925 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:930 msgid "" -"To display the type hint of the variable without a value, use the ``no-" -"value`` option. If both the ``annotation`` and ``no-value`` options are " -"used, ``no-value`` has no effect." +"To display the type hint of the variable without a value, use the ``:no-" +"value:`` option. If both the ``:annotation:`` and ``:no-value:`` options are" +" used, ``:no-value:`` has no effect." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:932 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:937 msgid "Configuration" msgstr "設定" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:934 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:939 msgid "There are also config values that you can set:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:938 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:0 +msgid "Type" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:0 +msgid "Default" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:945 msgid "" "This value selects what content will be inserted into the main body of an " ":rst:dir:`autoclass` directive. The possible values are:" @@ -744,39 +751,36 @@ msgstr "" "この値を指定することで、本体の\\ :rst:dir:`autoclass`\\ " "ディレクティブにどの内容を追加するのかを選択できます。指定可能な値は以下の通りです:" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:941 -msgid "``\"class\"``" -msgstr "``\"class\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:948 +msgid "``'class'``" +msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:942 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:949 msgid "" -"Only the class' docstring is inserted. This is the default. You can still " -"document ``__init__`` as a separate method using :rst:dir:`automethod` or " -"the ``members`` option to :rst:dir:`autoclass`." +"Only the class' docstring is inserted. You can still document ``__init__`` " +"as a separate method using :rst:dir:`automethod` or the ``members`` option " +"to :rst:dir:`autoclass`." msgstr "" -"クラスのdocstringだけが挿入されます。これがデフォルトの動作になります。\\ :rst:dir:`automethod`\\ を使用するか、\\" -" :rst:dir:`autoclass`\\ に対して\\ ``members``\\ オプションを設定することで、\\ ``__init__``\\" -" の内容は別のメソッドとしてドキュメント化できます。" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:945 -msgid "``\"both\"``" -msgstr "``\"both\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:952 +msgid "``'both'``" +msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:946 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:953 msgid "" "Both the class' and the ``__init__`` method's docstring are concatenated and" " inserted." msgstr "クラスのdocstringと、\\ ``__init__``\\ メソッドのdocstringの両方が結合されて挿入されます。" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:948 -msgid "``\"init\"``" -msgstr "``\"init\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:955 +msgid "``'init'``" +msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:949 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:956 msgid "Only the ``__init__`` method's docstring is inserted." msgstr "``__init__``\\ メソッドのdocstringだけが挿入されます。" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:953 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:960 msgid "" "If the class has no ``__init__`` method or if the ``__init__`` method's " "docstring is empty, but the class has a ``__new__`` method's docstring, it " @@ -785,96 +789,147 @@ msgstr "" "クラス内に ``__init__`` メソッドが定義されていない、または ``__init__`` メソッドのドックストリングが空で " "``__new__`` メソッドにドックストリングが記述されている場合は、 ``__new__`` メソッドのドックストリングが代わりに使用されます。" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:961 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:970 msgid "" "This value selects how the signature will be displayed for the class defined" " by :rst:dir:`autoclass` directive. The possible values are:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:964 -msgid "``\"mixed\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:973 +msgid "``'mixed'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:965 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:974 msgid "Display the signature with the class name." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:966 -msgid "``\"separated\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:975 +msgid "``'separated'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:967 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:976 msgid "Display the signature as a method." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:969 -msgid "The default is ``\"mixed\"``." -msgstr "" - -#: ../../sphinx/doc/usage/extensions/autodoc.rst:975 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:984 msgid "" -"This value selects if automatically documented members are sorted " -"alphabetical (value ``'alphabetical'``), by member type (value " -"``'groupwise'``) or by source order (value ``'bysource'``). The default is " -"alphabetical." +"Define the order in which :rst:dir:`automodule` and :rst:dir:`autoclass` " +"members are listed. Supported values are:" msgstr "" -"これの設定を変更することで、ドキュメントのついたメンバーをアルファベット順にソートするか(``'alphabetical'``)、もしくはメンバーのタイプによって(``'groupwise'``)ソートするか、ソースコードの定義順(``'bysource'``)にソートするかを変更できます。デフォルトはアルファベット順です。" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:984 -msgid "Support for ``'bysource'``." -msgstr "``'bysource'`` をサポートしました。" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:987 +msgid "``'alphabetical'``: Use alphabetical order." +msgstr "" #: ../../sphinx/doc/usage/extensions/autodoc.rst:989 -msgid "" -"This value is a list of autodoc directive flags that should be automatically" -" applied to all autodoc directives. The supported flags are ``'members'``, " -"``'undoc-members'``, ``'private-members'``, ``'special-members'``, " -"``'inherited-members'``, ``'show-inheritance'``, ``'ignore-module-all'`` and" -" ``'exclude-members'``." +msgid "``'groupwise'``: order by member type. The order is:" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:991 +msgid "for modules, exceptions, classes, functions, data" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:992 +msgid "for classes: methods, then properties and attributes" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:999 -msgid "Integrated into :confval:`autodoc_default_options`." +#: ../../sphinx/doc/usage/extensions/autodoc.rst:994 +msgid "Members are ordered alphabetically within groups." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1003 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:996 +msgid "" +"``'bysource'``: Use the order in which the members appear in the source " +"code. This requires that the module must be a Python module with the source " +"code available." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1002 +msgid "Support for ``'bysource'``." +msgstr "``'bysource'`` をサポートしました。" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1009 msgid "" "The default options for autodoc directives. They are applied to all autodoc" " directives automatically. It must be a dictionary which maps option names " "to the values. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1017 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1023 msgid "" "Setting ``None`` or ``True`` to the value is equivalent to giving only the " "option name to the directives." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1020 -msgid "" -"The supported options are ``'members'``, ``'member-order'``, ``'undoc-" -"members'``, ``'private-members'``, ``'special-members'``, ``'inherited-" -"members'``, ``'show-inheritance'``, ``'ignore-module-all'``, ``'imported-" -"members'``, ``'exclude-members'``, ``'class-doc-from'`` and ``'no-value'``." +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1026 +msgid "The supported options are:" msgstr "" #: ../../sphinx/doc/usage/extensions/autodoc.rst:1028 -msgid "Accepts ``True`` as a value." +msgid "``'members'``: See :rst:dir:`automodule:members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1029 +msgid "``'undoc-members'`` See :rst:dir:`automodule:undoc-members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1030 +msgid "``'private-members'``: See :rst:dir:`automodule:private-members`." msgstr "" #: ../../sphinx/doc/usage/extensions/autodoc.rst:1031 -msgid "Added ``'imported-members'``." +msgid "``'special-members'``: See :rst:dir:`automodule:special-members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1032 +msgid "``'inherited-members'``: See :rst:dir:`autoclass:inherited-members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1033 +msgid "``'imported-members'``: See :rst:dir:`automodule:imported-members`." msgstr "" #: ../../sphinx/doc/usage/extensions/autodoc.rst:1034 -msgid "Added ``'class-doc-from'``." +msgid "``'exclude-members'``: See :rst:dir:`automodule:exclude-members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1035 +msgid "``'ignore-module-all'``: See :rst:dir:`automodule:ignore-module-all`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1036 +msgid "``'member-order'``: See :rst:dir:`automodule:member-order`." msgstr "" #: ../../sphinx/doc/usage/extensions/autodoc.rst:1037 +msgid "``'show-inheritance'``: See :rst:dir:`autoclass:show-inheritance`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1038 +msgid "``'class-doc-from'``: See :rst:dir:`autoclass:class-doc-from`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1039 +msgid "``'no-value'``: See :rst:dir:`autodata:no-value`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1043 +msgid "Accepts ``True`` as a value." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1046 +msgid "Added ``'imported-members'``." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1049 +msgid "Added ``'class-doc-from'``." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1052 msgid "Added ``'no-value'``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1042 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1059 msgid "" "Functions imported from C modules cannot be introspected, and therefore the " "signature for such functions cannot be automatically determined. However, " @@ -883,7 +938,7 @@ msgid "" msgstr "" "Cモジュールからインポートされた関数は、情報を取得できないため、これらの関数に関するシグニチャを自動的に決定することはできません。しかし、これを使用すると、これらの関数のdocstringの最初の行に、これらの関数のシグニチャを入れられます。" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1047 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1064 msgid "" "If this boolean value is set to ``True`` (which is the default), autodoc " "will look at the first line of the docstring for functions and methods, and " @@ -893,22 +948,22 @@ msgstr "" "もしこの設定を ``True`` " "(デフォルト)にすると、autodocは関数やメソッドのdocstringの最初の行を見て、もしシグニチャのような情報が書かれていたら、その行をシグニチャとして読み込み、docstringからはその行の内容を削除して扱います。" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1052 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1069 msgid "" "autodoc will continue to look for multiple signature lines, stopping at the " "first line that does not look like a signature. This is useful for declaring" " overloaded function signatures." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1059 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1076 msgid "Support overloaded signatures" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1063 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1080 msgid "Overloaded signatures do not need to be separated by a backslash" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1067 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1086 msgid "" "This value contains a list of modules to be mocked up. This is useful when " "some external dependencies are not met at build time and break the building " @@ -917,198 +972,194 @@ msgid "" msgstr "" "この値はモックアップされるモジュールのリストを含みます。これはビルド時もしくはビルド過程の中断時にいくつかの外部依存が満たされない時に有用です。依存関係自体のルートパッケージのみを指定し、サブモジュールを省略できます:" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1076 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1095 msgid "Will mock all imports under the ``django`` package." msgstr " ``django`` パッケージの下でインポートされたすべてのものをモックします。" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1080 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1099 msgid "" "This config value only requires to declare the top-level modules that should" " be mocked." msgstr "この設定値は、モックされるべきトップレベルモジュールを宣言するためだけに必要です。" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1086 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1107 msgid "" "This value controls how to represent typehints. The setting takes the " "following values:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1089 -msgid "``'signature'`` -- Show typehints in the signature (default)" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1110 +msgid "``'signature'`` -- Show typehints in the signature" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1090 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1111 msgid "" "``'description'`` -- Show typehints as content of the function or method The" " typehints of overloaded functions or methods will still be represented in " "the signature." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1093 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1114 msgid "``'none'`` -- Do not show typehints" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1094 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1115 msgid "" "``'both'`` -- Show typehints in the signature and as content of the function" " or method" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1097 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1118 msgid "" "Overloaded functions or methods will not have typehints included in the " "description because it is impossible to accurately represent all possible " "overloads as a list of parameters." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1104 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1125 msgid "New option ``'description'`` is added." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1108 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1129 msgid "New option ``'both'`` is added." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1112 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1135 msgid "" "This value controls whether the types of undocumented parameters and return " -"values are documented when ``autodoc_typehints`` is set to ``description``." +"values are documented when :confval:`autodoc_typehints` is set to " +"``'description'``. Supported values:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1115 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1140 msgid "" -"The default value is ``\"all\"``, meaning that types are documented for all " -"parameters and return values, whether they are documented or not." +"``'all'``: Types are documented for all parameters and return values, " +"whether they are documented or not." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1118 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1143 msgid "" -"When set to ``\"documented\"``, types will only be documented for a " -"parameter or a return value that is already documented by the docstring." +"``'documented'``: Types will only be documented for a parameter or a return " +"value that is already documented by the docstring." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1121 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1146 msgid "" -"With ``\"documented_params\"``, parameter types will only be annotated if " -"the parameter is documented in the docstring. The return type is always " +"``'documented_params'``: Parameter types will only be annotated if the " +"parameter is documented in the docstring. The return type is always " "annotated (except if it is ``None``)." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1129 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1155 msgid "New option ``'documented_params'`` is added." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1133 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1161 msgid "" "A dictionary for users defined `type aliases`__ that maps a type name to the" " full-qualified object name. It is used to keep type aliases not evaluated " -"in the document. Defaults to empty (``{}``)." +"in the document." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1137 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1165 msgid "" "The type aliases are only available if your program enables :pep:`Postponed " "Evaluation of Annotations (PEP 563) <563>` feature via ``from __future__ " "import annotations``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1141 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1169 msgid "For example, there is code using a type alias:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1152 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1180 msgid "" "If ``autodoc_type_aliases`` is not set, autodoc will generate internal mark-" "up from this code as following:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1161 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1189 msgid "" "If you set ``autodoc_type_aliases`` as ``{'AliasType': " "'your.module.AliasType'}``, it generates the following document internally:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1176 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1206 msgid "" "This value controls the format of typehints. The setting takes the " "following values:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1179 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1209 msgid "" "``'fully-qualified'`` -- Show the module name and its name of typehints" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1180 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1210 msgid "" "``'short'`` -- Suppress the leading module names of the typehints (e.g. " -"``io.StringIO`` -> ``StringIO``) (default)" +"``io.StringIO`` -> ``StringIO``)" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1187 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1217 msgid "The default setting was changed to ``'short'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1191 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1223 msgid "" "If True, the default argument values of functions will be not evaluated on " "generating document. It preserves them as is in the source code." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1196 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1228 msgid "" "Added as an experimental feature. This will be integrated into autodoc core" " in the future." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1201 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1235 msgid "" "This value controls the behavior of :option:`sphinx-build --fail-on-warning`" " during importing modules. If ``False`` is given, autodoc forcedly " -"suppresses the error if the imported module emits warnings. By default, " -"``True``." +"suppresses the error if the imported module emits warnings." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1206 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1240 msgid "" "This option now has no effect as :option:`!--fail-on-warning` no longer " "exits early." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1212 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1248 msgid "" "This value controls the docstrings inheritance. If set to True the docstring" " for classes or methods, if not explicitly set, is inherited from parents." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1216 -msgid "The default is ``True``." -msgstr "デフォルト値は ``True`` です。" - -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1223 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1259 msgid "" -":mod:`autodoc` supports to suppress warning messages via " -":confval:`suppress_warnings`. It allows following warnings types in " -"addition:" +":mod:`autodoc` supports suppressing warning messages via " +":confval:`suppress_warnings`. It defines the following additional warnings " +"types:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1227 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1263 msgid "autodoc" msgstr "autodoc" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1228 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1264 msgid "autodoc.import_object" msgstr "autodoc.import_object" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1232 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1268 msgid "Docstring preprocessing" msgstr "Docstringのプリプロセス" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1234 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1270 msgid "autodoc provides the following additional events:" msgstr "autodocは以下のイベントを追加で提供します:" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1240 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1276 msgid "" "Emitted when autodoc has read and processed a docstring. *lines* is a list " "of strings -- the lines of the processed docstring -- that the event handler" @@ -1121,43 +1172,40 @@ msgstr "" msgid "Parameters" msgstr "パラメータ" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1244 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1263 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1275 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1304 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1336 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1280 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1299 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1311 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1340 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1372 msgid "the Sphinx application object" msgstr "Sphinxのアプリケーションオブジェクト" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1245 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1276 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1337 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1281 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1312 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1373 msgid "" -"the type of the object which the docstring belongs to (one of " -"``\"module\"``, ``\"class\"``, ``\"exception\"``, ``\"function\"``, " -"``\"method\"``, ``\"attribute\"``)" +"the type of the object which the docstring belongs to (one of ``'module'``, " +"``'class'``, ``'exception'``, ``'function'``, ``'method'``, ``'attribute'``)" msgstr "" -"docstringが属するオブジェクトの型 (以下のうちのどれか ``\"module\"``, ``\"class\"``, " -"``\"exception\"``, ``\"function\"``, ``\"method\"``, ``\"attribute\"``)" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1248 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1279 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1305 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1340 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1284 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1315 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1341 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1376 msgid "the fully qualified name of the object" msgstr "オブジェクトの完全な修飾付きの名前" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1249 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1264 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1280 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1306 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1341 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1285 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1300 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1316 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1342 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1377 msgid "the object itself" msgstr "オブジェクト自身" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1250 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1281 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1344 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1286 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1317 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1380 msgid "" "the options given to the directive: an object with attributes " "``inherited_members``, ``undoc_members``, ``show_inheritance`` and ``no-" @@ -1165,21 +1213,21 @@ msgid "" "directive" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1254 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1290 msgid "the lines of the docstring, see above" msgstr "docstringの行数。上記を参照。" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1260 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1296 msgid "" "Emitted before autodoc formats a signature for an object. The event handler " "can modify an object to change its signature." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1265 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1301 msgid "a boolean indicates an object is bound method or not" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1271 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1307 msgid "" "Emitted when autodoc has formatted a signature for an object. The event " "handler can return a new tuple ``(signature, return_annotation)`` to change " @@ -1188,25 +1236,20 @@ msgstr "" "autodocがオブジェクトのシグニチャをフォーマットしているときに呼び出されます。イベントハンドラは新しいタプル\\ ``(signature, " "return_annotation)``\\ を返すことができ、Sphinxはこの出力を使ってドキュメントを生成します。" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1285 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1321 msgid "" -"function signature, as a string of the form ``\"(parameter_1, " -"parameter_2)\"``, or ``None`` if introspection didn't succeed and signature " +"function signature, as a string of the form ``'(parameter_1, " +"parameter_2)'``, or ``None`` if introspection didn't succeed and signature " "wasn't specified in the directive." msgstr "" -"``\"(parameter_1, parameter_2)\"`` " -"という形式の文字列で示される関数シグニチャか、あるいは、イントロスペクションが成功せず、シグニチャをディレクティブ中で特定できない場合には " -"``None`` となります。" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1288 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1324 msgid "" -"function return annotation as a string of the form ``\" -> annotation\"``, " -"or ``None`` if there is no return annotation" +"function return annotation as a string of the form ``' -> annotation'``, or " +"``None`` if there is no return annotation" msgstr "" -"アノテーションを ``\" -> annotation\"`` という形式の文字列で返す関数か、アノテーションを返さない場合は ``None`` " -"となります。" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1291 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1327 msgid "" "The :mod:`sphinx.ext.autodoc` module provides factory functions for commonly" " needed docstring processing in event :event:`autodoc-process-docstring`:" @@ -1254,7 +1297,7 @@ msgid "" " be processed." msgstr "もしも *what* として、文字列の配列が渡されると、この *what* に含まれているタイプのdocstringだけが処理されます。" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1299 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1335 msgid "" "Emitted when autodoc has read and processed a class to determine the base-" "classes. *bases* is a list of classes that the event handler can modify " @@ -1262,31 +1305,31 @@ msgid "" "if ``show-inheritance`` option given." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1307 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1343 msgid "the options given to the class directive" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1308 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1344 msgid "the list of base classes signature. see above." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1313 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1349 msgid "" "``bases`` can contain a string as a base class name. It will be processed as" " reStructuredText." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1318 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1354 msgid "Skipping members" msgstr "メンバーのスキップ" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1320 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1356 msgid "" "autodoc allows the user to define a custom method for determining whether a " "member should be included in the documentation by using the following event:" msgstr "autodocでは以下のイベントを発行することで、指定されたメンバーをドキュメントに含めるかどうかをユーザが決定できるようになっています:" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1327 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1363 msgid "" "Emitted when autodoc has to decide whether a member should be included in " "the documentation. The member is excluded if a handler returns ``True``. " @@ -1295,7 +1338,7 @@ msgstr "" "autodocがメンバーをドキュメントに含めるかどうかを決定するときに呼ばれます。もしもこのハンドラーが\\ ``True``\\ " "を返すとメンバーのドキュメントは外されます。\\ ``False``\\ を返すと含まれるようになります。" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1331 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1367 msgid "" "If more than one enabled extension handles the ``autodoc-skip-member`` " "event, autodoc will use the first non-``None`` value returned by a handler. " @@ -1306,7 +1349,7 @@ msgstr "" "``None`` 値を使用します。ハンドラは、autodocおよびその他の有効な拡張モジュールのスキップ動作に戻るには、 ``None`` " "を返す必要があります。" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1342 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1378 msgid "" "a boolean indicating if autodoc will skip this member if the user handler " "does not override the decision" diff --git a/locale/ko/LC_MESSAGES/changes/1.8.po b/locale/ko/LC_MESSAGES/changes/1.8.po index 528fd67107..65c4e0267f 100644 --- a/locale/ko/LC_MESSAGES/changes/1.8.po +++ b/locale/ko/LC_MESSAGES/changes/1.8.po @@ -11,7 +11,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-10-01 00:54+0000\n" +"POT-Creation-Date: 2024-10-03 00:49+0000\n" "PO-Revision-Date: 2024-07-31 00:36+0000\n" "Last-Translator: YT H , 2024\n" "Language-Team: Korean (https://app.transifex.com/sphinx-doc/teams/15434/ko/)\n" @@ -400,7 +400,7 @@ msgstr "" #: ../../sphinx/doc/changes/1.8.rst:150 msgid "" "#5421: autodoc emits deprecation warning for " -":confval:`autodoc_default_flags`" +":confval:`!autodoc_default_flags`" msgstr "" #: ../../sphinx/doc/changes/1.8.rst:151 @@ -668,7 +668,7 @@ msgid ":confval:`!source_parsers` is deprecated" msgstr "" #: ../../sphinx/doc/changes/1.8.rst:254 -msgid ":confval:`autodoc_default_flags` is deprecated" +msgid ":confval:`!autodoc_default_flags` is deprecated" msgstr "" #: ../../sphinx/doc/changes/1.8.rst:255 diff --git a/locale/ko/LC_MESSAGES/changes/index.po b/locale/ko/LC_MESSAGES/changes/index.po index d34f91bb62..27dffe3178 100644 --- a/locale/ko/LC_MESSAGES/changes/index.po +++ b/locale/ko/LC_MESSAGES/changes/index.po @@ -11,7 +11,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-09-28 00:48+0000\n" +"POT-Creation-Date: 2024-10-03 00:49+0000\n" "PO-Revision-Date: 2024-07-31 00:36+0000\n" "Last-Translator: YT H , 2024\n" "Language-Team: Korean (https://app.transifex.com/sphinx-doc/teams/15434/ko/)\n" @@ -238,11 +238,18 @@ msgid "" ":rst:dir:`py:module` directives. Patch by Stephen Finucane." msgstr "" -#: ../../sphinx/CHANGES.rst:112 +#: ../../sphinx/CHANGES.rst:110 +msgid "" +"#12916: Restore support for custom templates named with the legacy ``_t`` " +"suffix during ``apidoc`` RST rendering (regression in 7.4.0). Patch by James" +" Addison." +msgstr "" + +#: ../../sphinx/CHANGES.rst:115 msgid "Testing" msgstr "" -#: ../../sphinx/CHANGES.rst:114 +#: ../../sphinx/CHANGES.rst:117 msgid "" "#12141: Migrate from the deprecated ``karma`` JavaScript test framework to " "the actively-maintained ``jasmine`` framework. Test coverage is unaffected." diff --git a/locale/ko/LC_MESSAGES/extdev/deprecated.po b/locale/ko/LC_MESSAGES/extdev/deprecated.po index 900e02d897..220dd32658 100644 --- a/locale/ko/LC_MESSAGES/extdev/deprecated.po +++ b/locale/ko/LC_MESSAGES/extdev/deprecated.po @@ -11,7 +11,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-09-02 00:47+0000\n" +"POT-Creation-Date: 2024-10-03 00:50+0000\n" "PO-Revision-Date: 2019-03-09 18:04+0000\n" "Last-Translator: YT H , 2021\n" "Language-Team: Korean (https://app.transifex.com/sphinx-doc/teams/15434/ko/)\n" @@ -2852,7 +2852,7 @@ msgid ":meth:`~sphinx.application.Sphinx.add_js_file`" msgstr "" #: ../../sphinx/doc/extdev/deprecated.rst:1457 -msgid ":confval:`autodoc_default_flags`" +msgid ":confval:`!autodoc_default_flags`" msgstr "" #: ../../sphinx/doc/extdev/deprecated.rst:1460 diff --git a/locale/ko/LC_MESSAGES/usage/domains/restructuredtext.po b/locale/ko/LC_MESSAGES/usage/domains/restructuredtext.po index 9eb93d6137..f7959cfa7c 100644 --- a/locale/ko/LC_MESSAGES/usage/domains/restructuredtext.po +++ b/locale/ko/LC_MESSAGES/usage/domains/restructuredtext.po @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-09-15 00:53+0000\n" +"POT-Creation-Date: 2024-10-03 00:49+0000\n" "PO-Revision-Date: 2023-10-03 00:37+0000\n" "Language-Team: Korean (https://app.transifex.com/sphinx-doc/teams/15434/ko/)\n" "MIME-Version: 1.0\n" @@ -75,3 +75,20 @@ msgstr "" #: ../../sphinx/doc/usage/domains/restructuredtext.rst:97 msgid "These roles are provided to refer to the described objects:" msgstr "" + +#: ../../sphinx/doc/usage/domains/restructuredtext.rst:101 +msgid "Reference directives and directive options. Examples:" +msgstr "" + +#: ../../sphinx/doc/usage/domains/restructuredtext.rst:103 +msgid "Use ``:rst:dir:`my-directive``` to reference a directive." +msgstr "" + +#: ../../sphinx/doc/usage/domains/restructuredtext.rst:104 +msgid "" +"Use ``:rst:dir:`my-directive:my-option``` to reference a directive option." +msgstr "" + +#: ../../sphinx/doc/usage/domains/restructuredtext.rst:109 +msgid "Reference a role. Example: ``:rst:role:`my-role```." +msgstr "" diff --git a/locale/ko/LC_MESSAGES/usage/extensions/autodoc.po b/locale/ko/LC_MESSAGES/usage/extensions/autodoc.po index 0eb374617f..a1238d68af 100644 --- a/locale/ko/LC_MESSAGES/usage/extensions/autodoc.po +++ b/locale/ko/LC_MESSAGES/usage/extensions/autodoc.po @@ -11,7 +11,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-10-02 00:49+0000\n" +"POT-Creation-Date: 2024-10-03 00:50+0000\n" "PO-Revision-Date: 2018-06-26 15:58+0000\n" "Last-Translator: Georg Brandl , 2018\n" "Language-Team: Korean (https://app.transifex.com/sphinx-doc/teams/15434/ko/)\n" @@ -25,26 +25,26 @@ msgstr "" msgid ":mod:`sphinx.ext.autodoc` -- Include documentation from docstrings" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:12 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:15 msgid "" "This extension can import the modules you are documenting, and pull in " "documentation from docstrings in a semi-automatic way." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:17 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:20 msgid "" ":mod:`~sphinx.ext.autodoc` **imports** the modules to be documented. If any " "modules have side effects on import, these will be executed by ``autodoc`` " "when :program:`sphinx-build` is run." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:21 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:24 msgid "" "If you document scripts (as opposed to library modules), make sure that the " "main routine is protected by an ``if __name__ == '__main__'`` condition." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:25 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:28 msgid "" "For this to work, the docstrings must of course be written in correct " "reStructuredText. You can then use all of the usual Sphinx markup in the " @@ -54,7 +54,7 @@ msgid "" "auto-generated-looking pure API documentation." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:33 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:36 msgid "" "If you prefer `NumPy`_ or `Google`_ style docstrings over reStructuredText, " "you can also enable the :mod:`napoleon ` extension. " @@ -62,25 +62,25 @@ msgid "" "reStructuredText before ``autodoc`` processes them." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:43 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:46 msgid "Getting started" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:47 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:50 msgid "Setup" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:49 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:52 msgid "" "Activate the plugin by adding ``'sphinx.ext.autodoc'`` to the " ":confval:`extensions` list in :file:`conf.py`:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:61 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:64 msgid "Ensuring the code can be imported" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:63 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:66 msgid "" ":mod:`~sphinx.ext.autodoc` analyses the code and docstrings by introspection" " after **importing the modules**. For importing to work, you have to make " @@ -90,11 +90,11 @@ msgid "" "fail)." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:70 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:73 msgid "There are two ways to ensure this:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:72 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:75 msgid "" "Use an environment that contains your package and Sphinx. This can e.g. be " "your local development environment (with an editable install), or an " @@ -103,14 +103,14 @@ msgid "" "that all dependencies are available." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:78 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:81 msgid "" "It is alternatively possible to patch the Sphinx run so that it can operate " "directly on the sources; e.g. if you want to be able to do a Sphinx build " "from a source checkout." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:82 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:85 msgid "" "Patch :data:`sys.path` in :file:`conf.py` to include your source path. For " "example if you have a repository structure with :file:`doc/conf.py` and your" @@ -118,17 +118,17 @@ msgid "" "your :file:`conf.py`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:94 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:97 msgid "" "To cope with missing dependencies, specify the missing modules in the " ":confval:`autodoc_mock_imports` setting." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:99 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:102 msgid "Usage" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:101 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:104 msgid "" "You can now use the :ref:`autodoc-directives` to add formatted documentation" " for Python code elements like functions, classes, modules, etc. For " @@ -136,48 +136,48 @@ msgid "" "docstring from the source file, you'd write:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:110 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:113 msgid "" "You can also document whole classes or even modules automatically, using " "member options for the auto directives, like:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:119 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:122 msgid "" "As a hint to autodoc extension, you can put a ``::`` separator between the " "module name and the object name to let autodoc know the correct module, if " "it is ambiguous:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:129 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:132 msgid "Marking objects as public or private" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:131 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:134 msgid "" "autodoc considers a member private if its docstring contains ``:meta " "private:`` in its :ref:`info-field-lists`. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:145 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:148 msgid "" "autodoc considers a member public if its docstring contains ``:meta " "public:`` in its :ref:`info-field-lists`, even if it starts with an " "underscore. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:160 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:163 msgid "" "autodoc considers a variable member does not have any default value if its " "docstring contains ``:meta hide-value:`` in its :ref:`info-field-lists`. " "Example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:174 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:177 msgid "Doc comments and docstrings" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:176 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:179 msgid "" "Python has no built-in support for docstrings for module data members or " "class attributes. To allow documenting these, ``autodoc`` recognises a " @@ -185,7 +185,7 @@ msgid "" " 'documentation comment'." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:181 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:184 msgid "" "These comments start with a colon and an optional space character, ``'#:'`` " "or ``'#: '``. To be recognised, the comments must appear either on the same " @@ -194,28 +194,28 @@ msgid "" "definition." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:188 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:191 msgid "" "For example, all three of the following variables have valid doc-comments:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:202 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:205 msgid "" "Alternatively, ``autodoc`` can recognise a docstring on the line immediately" " following the definition." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:205 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:208 msgid "" "In the the following class definition, all attributes have documentation " "recognised by ``autodoc``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:233 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:236 msgid "Directives" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:235 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:238 msgid "" ":mod:`autodoc` provides several directives that are versions of the usual " ":rst:dir:`py:module`, :rst:dir:`py:class` and so forth. On parsing time, " @@ -224,24 +224,24 @@ msgid "" ":rst:dir:`py:module`, :rst:dir:`py:class` etc. directive." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:244 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:247 msgid "" "Just as :rst:dir:`py:class` respects the current :rst:dir:`py:module`, " ":rst:dir:`autoclass` will also do so. Likewise, :rst:dir:`automethod` will " "respect the current :rst:dir:`py:class`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:250 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:253 msgid "Default directive options" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:252 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:255 msgid "" "To make any of the options described below the default, use the " ":confval:`autodoc_default_options` dictionary in :file:`conf.py`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:255 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:258 msgid "" "If using defaults for the ``:members:``, ``:exclude-members:``, ``:private-" "members:``, or ``:special-members:`` options, setting the option on a " @@ -250,111 +250,111 @@ msgid "" "(``+``), as follows:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:269 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:272 msgid "" "If using :confval:`autodoc_default_options`, the defaults can be disabled " "per-directive with the negated form, :samp:`:no-{option}:` as an option of " "the directive For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:281 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:284 msgid "Automatically document modules" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:285 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:288 msgid "" "Document a module. By default, the directive only inserts the docstring of " "the module itself:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:292 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:526 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:792 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:866 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:295 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:531 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:797 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:871 msgid "will produce source like this:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:300 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:534 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:303 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:539 msgid "" "The directive can also contain content of its own, which will be inserted " "into the resulting non-auto directive source after the docstring (but before" " any automatic member documentation)." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:304 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:538 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:878 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:307 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:543 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:883 msgid "" "Therefore, you can also mix automatic and non-automatic member " "documentation, as follows:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:317 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:567 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:844 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:894 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:320 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:572 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:849 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:899 msgid "Options" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:321 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:324 msgid "" "Do not generate an index entry for the documented module or any auto-" "documented members." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:329 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:332 msgid "" "Indicate platforms on which the module is available. This is identical to " ":rst:dir:`py:module`'s ``:platform:`` option." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:335 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:338 msgid "" "A sentence describing the module's purpose. This is identical to " ":rst:dir:`py:module`'s ``:synopsis:`` option." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:343 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:346 msgid "" "Mark a module as deprecated. This is identical to :rst:dir:`py:module`'s " "``:deprecated:`` option." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:351 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:354 msgid "Do not use ``__all__`` when analysing the module to document." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:356 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:600 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:359 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:605 msgid "Options for selecting members to document" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:360 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:363 msgid "Generate automatic documentation for all members of the target module:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:367 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:370 msgid "" "By default, ``autodoc`` only includes public members with a docstring or " ":ref:`doc-comment ` (``#:``). If ``__all__`` exists, it will be" -" used to define which members are public, unless the ``:ignore-module-all:``" -" option is set." +" used to define which members are public, unless the :rst:dir:`:ignore-" +"module-all: ` option is set." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:372 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:615 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:376 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:620 msgid "" "To only document certain members, an explicit comma-separated list may be " "used as the argument to ``:members:``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:383 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:626 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:387 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:631 msgid "Exclude the given names from the members to document. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:397 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:401 msgid "" "To prevent documentation of imported classes or functions, in an " ":rst:dir:`!automodule` directive with the ``members`` option set, only " @@ -362,198 +362,197 @@ msgid "" "name given to ``automodule`` will be documented." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:402 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:406 msgid "" "Set the ``imported-members`` option if you want to prevent this behavior and" " document all available members." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:405 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:409 msgid "" "Note that attributes from imported modules will not be documented, because " "attribute documentation is discovered by parsing the source file of the " "current module." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:414 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:418 msgid "" "Generate automatic documentation for members of the target module that don't" " have a docstring or doc-comment. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:427 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:431 msgid "" "Generate automatic documentation for private members of the target module. " "This includes names with a leading underscore (e.g. ``_private``) and those " "members explicitly marked as private with ``:meta private:``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:437 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:703 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:441 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:708 msgid "" "To only document certain private members, an explicit comma-separated list " "may be used as the argument to ``:private-members:``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:447 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:475 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:741 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:451 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:479 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:746 msgid "The option can now take a comma-separated list of arguments." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:453 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:457 msgid "" "Generate automatic documentation for special members of the target module, " -"also known as :ref:`\"dunder\" names `. This includes " -"all names enclosed with a double-underscore, e.g. ``__special__``:" +"also known as :ref:`'dunder' names `. This includes all" +" names enclosed with a double-underscore, e.g. ``__special__``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:464 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:730 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:468 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:735 msgid "" "To only document certain special members, an explicit comma-separated list " "may be used as the argument to ``:special-members:``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:479 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:745 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:483 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:750 msgid "Options for documented members" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:483 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:749 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:487 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:754 msgid "" "Choose the ordering of automatically documented members (default: " "``alphabetical``). This overrides the :confval:`autodoc_member_order` " "setting." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:487 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:491 msgid "``alphabetical``: Use simple alphabetical order." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:489 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:493 msgid "" "``groupwise``: Group by object type (class, function, etc), use alphabetical" " order within groups." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:492 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:496 msgid "" "``bysource``: Use the order of objects in the module's source. The " "``__all__`` variable can be used to override this order." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:496 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:762 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:980 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:500 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:767 msgid "" "Note that for source order, the module must be a Python module with the " "source code available." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:500 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:766 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:504 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:771 msgid "Support the ``'bysource'`` option." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:506 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:510 msgid "" -"Enable the ``:show-inheritance:`` option for all members of the module, if " -"``:members:`` is enabled." +"Enable the :rst:dir:`:show-inheritance: ` option" +" for all members of the module, if ``:members:`` is enabled." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:513 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:518 msgid "Automatically document classes or exceptions" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:518 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:523 msgid "" -"Document a class. For exception classes, prefer ``autoexception``. By " +"Document a class. For exception classes, prefer ``.. autoexception::``. By " "default, the directive only inserts the docstring of the class itself:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:551 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:828 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:556 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:833 msgid "Advanced usage" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:552 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:829 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:557 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:834 msgid "" "It is possible to override the signature for explicitly documented callable " "objects (functions, methods, classes) with the regular syntax that will " "override the signature gained from introspection:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:562 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:839 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:567 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:844 msgid "" "This is useful if the signature from the method is hidden by a decorator." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:571 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:898 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:576 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:903 msgid "" "Do not generate an index entry for the documented class or any auto-" "documented members." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:579 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:584 msgid "" "Select which docstring will be used for the main body of the directive. This" " overrides the global value of :confval:`autoclass_content`. The possible " "values are:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:583 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:588 msgid "" "``class``: Only use the class's docstring. The :meth:`!__init__` method can " "be separately documented using the ``:members:`` option or " ":rst:dir:`automethod`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:587 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:592 msgid "``init``: Only use the docstring of the :meth:`!__init__` method." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:589 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:594 msgid "" -"``both`` Use both, appending the docstring of the :meth:`!__init__` method " +"``both``: Use both, appending the docstring of the :meth:`!__init__` method " "to the class's docstring." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:593 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:598 msgid "" "If the :meth:`!__init__` method doesn't exist or has a blank docstring, " "``autodoc`` will attempt to use the :meth:`!__new__` method's docstring, if " "it exists and is not blank." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:604 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:609 msgid "Generate automatic documentation for all members of the target class:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:611 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:616 msgid "" "By default, ``autodoc`` only includes public members with a docstring or " ":ref:`doc-comment ` (``#:``) that are attributes of the target " "class (i.e. not inherited)." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:640 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:645 msgid "" "To generate automatic documentation for members inherited from base classes," " use the ``:inherited-members:`` option:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:649 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:654 msgid "" "This can be combined with the ``:undoc-members:`` option to generate " "automatic documentation for *all* available members of the class." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:652 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:657 msgid "" "The members of classes listed in the argument to ``:inherited-members:`` are" " excluded from the automatic documentation. This defaults to " @@ -562,105 +561,105 @@ msgid "" "as the argument." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:658 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:663 msgid "" "For example; If your class ``MyList`` is derived from ``list`` class and you" " don't want to document ``list.__len__()``, you should specify a option " "``:inherited-members: list`` to avoid special members of list class." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:664 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:669 msgid "" "Should any of the inherited members use a format other than reStructuredText" " for their docstrings, there may be markup warnings or errors." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:670 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:675 msgid "" "``:inherited-members:`` now takes the name of a base class to exclude as an " "argument." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:674 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:679 msgid "A comma separated list of base class names can be used." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:680 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:685 msgid "" "Generate automatic documentation for members of the target class that don't " "have a docstring or doc-comment. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:693 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:698 msgid "" "Generate automatic documentation for private members of the target class. " "This includes names with a leading underscore (e.g. ``_private``) and those " "members explicitly marked as private with ``:meta private:``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:713 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:718 msgid "The option can now take arguments." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:719 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:724 msgid "" "Generate automatic documentation for special members of the target class, " -"also known as :ref:`\"dunder\" names `. This includes " -"all names enclosed with a double-underscore, e.g. ``__special__``:" +"also known as :ref:`'dunder' names `. This includes all" +" names enclosed with a double-underscore, e.g. ``__special__``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:753 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:758 msgid "``'alphabetical'``: Use simple alphabetical order." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:755 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:760 msgid "" "``'groupwise'``: Group by object type (class, function, etc), use " "alphabetical order within groups." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:758 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:763 msgid "" "``'bysource'``: Use the order of objects in the module's source. The " "``__all__`` variable can be used to override this order." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:772 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:777 msgid "Insert the class's base classes after the class signature." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:778 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:783 msgid "Automatically document function-like objects" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:785 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:790 msgid "" "Document a function, method, property, or decorator. By default, the " "directive only inserts the docstring of the function itself:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:800 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:874 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:805 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:879 msgid "" "The directive can also contain content of its own, which will be inserted " "into the resulting non-auto directive source after the docstring." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:804 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:809 msgid "" "Therefore, you can also mix automatic and non-automatic documentation, as " "follows:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:813 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:818 msgid ":rst:dir:`autodecorator`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:815 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:820 msgid ":rst:dir:`autoproperty`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:820 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:825 msgid "" "If you document decorated functions or methods, keep in mind that " "``autodoc`` retrieves its docstrings by importing the module and inspecting " @@ -669,30 +668,30 @@ msgid "" "the original ``__doc__`` to the new function." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:848 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:853 msgid "Do not generate an index entry for the documented function." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:854 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:859 msgid "Automatically document attributes or data" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:859 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:864 msgid "" "Document a module level variable or constant ('data') or class attribute. By" " default, the directive only inserts the docstring of the variable itself:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:887 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:892 msgid "" ":rst:dir:`autodata` and :rst:dir:`autoattribute` can now extract docstrings." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:890 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:895 msgid "Doc-comments are now allowed on the same line of an assignment." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:908 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:913 msgid "" "By default, ``autodoc`` attempts to obtain the type annotation and value of " "the variable by introspection, displaying it after the variable's name. To " @@ -700,165 +699,225 @@ msgid "" "argument to ``annotation``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:914 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:919 msgid "" "For example, if the runtime value of ``FILE_MODE`` is ``0o755``, the " "displayed value will be ``493`` (as ``oct(493) == '0o755'``). This can be " "fixed by setting ``:annotation: = 0o755``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:918 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:923 msgid "" -"If ``annotation`` is used without arguments, no value or type hint will be " -"shown for the variable." +"If ``:annotation:`` is used without arguments, no value or type hint will be" +" shown for the variable." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:925 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:930 msgid "" -"To display the type hint of the variable without a value, use the ``no-" -"value`` option. If both the ``annotation`` and ``no-value`` options are " -"used, ``no-value`` has no effect." +"To display the type hint of the variable without a value, use the ``:no-" +"value:`` option. If both the ``:annotation:`` and ``:no-value:`` options are" +" used, ``:no-value:`` has no effect." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:932 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:937 msgid "Configuration" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:934 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:939 msgid "There are also config values that you can set:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:938 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:0 +msgid "Type" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:0 +msgid "Default" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:945 msgid "" "This value selects what content will be inserted into the main body of an " ":rst:dir:`autoclass` directive. The possible values are:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:941 -msgid "``\"class\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:948 +msgid "``'class'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:942 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:949 msgid "" -"Only the class' docstring is inserted. This is the default. You can still " -"document ``__init__`` as a separate method using :rst:dir:`automethod` or " -"the ``members`` option to :rst:dir:`autoclass`." +"Only the class' docstring is inserted. You can still document ``__init__`` " +"as a separate method using :rst:dir:`automethod` or the ``members`` option " +"to :rst:dir:`autoclass`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:945 -msgid "``\"both\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:952 +msgid "``'both'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:946 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:953 msgid "" "Both the class' and the ``__init__`` method's docstring are concatenated and" " inserted." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:948 -msgid "``\"init\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:955 +msgid "``'init'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:949 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:956 msgid "Only the ``__init__`` method's docstring is inserted." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:953 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:960 msgid "" "If the class has no ``__init__`` method or if the ``__init__`` method's " "docstring is empty, but the class has a ``__new__`` method's docstring, it " "is used instead." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:961 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:970 msgid "" "This value selects how the signature will be displayed for the class defined" " by :rst:dir:`autoclass` directive. The possible values are:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:964 -msgid "``\"mixed\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:973 +msgid "``'mixed'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:965 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:974 msgid "Display the signature with the class name." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:966 -msgid "``\"separated\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:975 +msgid "``'separated'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:967 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:976 msgid "Display the signature as a method." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:969 -msgid "The default is ``\"mixed\"``." -msgstr "" - -#: ../../sphinx/doc/usage/extensions/autodoc.rst:975 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:984 msgid "" -"This value selects if automatically documented members are sorted " -"alphabetical (value ``'alphabetical'``), by member type (value " -"``'groupwise'``) or by source order (value ``'bysource'``). The default is " -"alphabetical." +"Define the order in which :rst:dir:`automodule` and :rst:dir:`autoclass` " +"members are listed. Supported values are:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:984 -msgid "Support for ``'bysource'``." +#: ../../sphinx/doc/usage/extensions/autodoc.rst:987 +msgid "``'alphabetical'``: Use alphabetical order." msgstr "" #: ../../sphinx/doc/usage/extensions/autodoc.rst:989 +msgid "``'groupwise'``: order by member type. The order is:" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:991 +msgid "for modules, exceptions, classes, functions, data" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:992 +msgid "for classes: methods, then properties and attributes" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:994 +msgid "Members are ordered alphabetically within groups." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:996 msgid "" -"This value is a list of autodoc directive flags that should be automatically" -" applied to all autodoc directives. The supported flags are ``'members'``, " -"``'undoc-members'``, ``'private-members'``, ``'special-members'``, " -"``'inherited-members'``, ``'show-inheritance'``, ``'ignore-module-all'`` and" -" ``'exclude-members'``." +"``'bysource'``: Use the order in which the members appear in the source " +"code. This requires that the module must be a Python module with the source " +"code available." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:999 -msgid "Integrated into :confval:`autodoc_default_options`." +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1002 +msgid "Support for ``'bysource'``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1003 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1009 msgid "" "The default options for autodoc directives. They are applied to all autodoc" " directives automatically. It must be a dictionary which maps option names " "to the values. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1017 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1023 msgid "" "Setting ``None`` or ``True`` to the value is equivalent to giving only the " "option name to the directives." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1020 -msgid "" -"The supported options are ``'members'``, ``'member-order'``, ``'undoc-" -"members'``, ``'private-members'``, ``'special-members'``, ``'inherited-" -"members'``, ``'show-inheritance'``, ``'ignore-module-all'``, ``'imported-" -"members'``, ``'exclude-members'``, ``'class-doc-from'`` and ``'no-value'``." +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1026 +msgid "The supported options are:" msgstr "" #: ../../sphinx/doc/usage/extensions/autodoc.rst:1028 -msgid "Accepts ``True`` as a value." +msgid "``'members'``: See :rst:dir:`automodule:members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1029 +msgid "``'undoc-members'`` See :rst:dir:`automodule:undoc-members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1030 +msgid "``'private-members'``: See :rst:dir:`automodule:private-members`." msgstr "" #: ../../sphinx/doc/usage/extensions/autodoc.rst:1031 -msgid "Added ``'imported-members'``." +msgid "``'special-members'``: See :rst:dir:`automodule:special-members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1032 +msgid "``'inherited-members'``: See :rst:dir:`autoclass:inherited-members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1033 +msgid "``'imported-members'``: See :rst:dir:`automodule:imported-members`." msgstr "" #: ../../sphinx/doc/usage/extensions/autodoc.rst:1034 -msgid "Added ``'class-doc-from'``." +msgid "``'exclude-members'``: See :rst:dir:`automodule:exclude-members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1035 +msgid "``'ignore-module-all'``: See :rst:dir:`automodule:ignore-module-all`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1036 +msgid "``'member-order'``: See :rst:dir:`automodule:member-order`." msgstr "" #: ../../sphinx/doc/usage/extensions/autodoc.rst:1037 +msgid "``'show-inheritance'``: See :rst:dir:`autoclass:show-inheritance`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1038 +msgid "``'class-doc-from'``: See :rst:dir:`autoclass:class-doc-from`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1039 +msgid "``'no-value'``: See :rst:dir:`autodata:no-value`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1043 +msgid "Accepts ``True`` as a value." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1046 +msgid "Added ``'imported-members'``." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1049 +msgid "Added ``'class-doc-from'``." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1052 msgid "Added ``'no-value'``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1042 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1059 msgid "" "Functions imported from C modules cannot be introspected, and therefore the " "signature for such functions cannot be automatically determined. However, " @@ -866,7 +925,7 @@ msgid "" "the function's docstring." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1047 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1064 msgid "" "If this boolean value is set to ``True`` (which is the default), autodoc " "will look at the first line of the docstring for functions and methods, and " @@ -874,22 +933,22 @@ msgid "" "from the docstring content." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1052 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1069 msgid "" "autodoc will continue to look for multiple signature lines, stopping at the " "first line that does not look like a signature. This is useful for declaring" " overloaded function signatures." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1059 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1076 msgid "Support overloaded signatures" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1063 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1080 msgid "Overloaded signatures do not need to be separated by a backslash" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1067 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1086 msgid "" "This value contains a list of modules to be mocked up. This is useful when " "some external dependencies are not met at build time and break the building " @@ -897,198 +956,194 @@ msgid "" "themselves and omit the sub-modules:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1076 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1095 msgid "Will mock all imports under the ``django`` package." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1080 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1099 msgid "" "This config value only requires to declare the top-level modules that should" " be mocked." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1086 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1107 msgid "" "This value controls how to represent typehints. The setting takes the " "following values:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1089 -msgid "``'signature'`` -- Show typehints in the signature (default)" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1110 +msgid "``'signature'`` -- Show typehints in the signature" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1090 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1111 msgid "" "``'description'`` -- Show typehints as content of the function or method The" " typehints of overloaded functions or methods will still be represented in " "the signature." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1093 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1114 msgid "``'none'`` -- Do not show typehints" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1094 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1115 msgid "" "``'both'`` -- Show typehints in the signature and as content of the function" " or method" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1097 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1118 msgid "" "Overloaded functions or methods will not have typehints included in the " "description because it is impossible to accurately represent all possible " "overloads as a list of parameters." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1104 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1125 msgid "New option ``'description'`` is added." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1108 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1129 msgid "New option ``'both'`` is added." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1112 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1135 msgid "" "This value controls whether the types of undocumented parameters and return " -"values are documented when ``autodoc_typehints`` is set to ``description``." +"values are documented when :confval:`autodoc_typehints` is set to " +"``'description'``. Supported values:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1115 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1140 msgid "" -"The default value is ``\"all\"``, meaning that types are documented for all " -"parameters and return values, whether they are documented or not." +"``'all'``: Types are documented for all parameters and return values, " +"whether they are documented or not." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1118 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1143 msgid "" -"When set to ``\"documented\"``, types will only be documented for a " -"parameter or a return value that is already documented by the docstring." +"``'documented'``: Types will only be documented for a parameter or a return " +"value that is already documented by the docstring." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1121 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1146 msgid "" -"With ``\"documented_params\"``, parameter types will only be annotated if " -"the parameter is documented in the docstring. The return type is always " +"``'documented_params'``: Parameter types will only be annotated if the " +"parameter is documented in the docstring. The return type is always " "annotated (except if it is ``None``)." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1129 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1155 msgid "New option ``'documented_params'`` is added." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1133 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1161 msgid "" "A dictionary for users defined `type aliases`__ that maps a type name to the" " full-qualified object name. It is used to keep type aliases not evaluated " -"in the document. Defaults to empty (``{}``)." +"in the document." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1137 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1165 msgid "" "The type aliases are only available if your program enables :pep:`Postponed " "Evaluation of Annotations (PEP 563) <563>` feature via ``from __future__ " "import annotations``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1141 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1169 msgid "For example, there is code using a type alias:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1152 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1180 msgid "" "If ``autodoc_type_aliases`` is not set, autodoc will generate internal mark-" "up from this code as following:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1161 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1189 msgid "" "If you set ``autodoc_type_aliases`` as ``{'AliasType': " "'your.module.AliasType'}``, it generates the following document internally:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1176 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1206 msgid "" "This value controls the format of typehints. The setting takes the " "following values:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1179 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1209 msgid "" "``'fully-qualified'`` -- Show the module name and its name of typehints" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1180 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1210 msgid "" "``'short'`` -- Suppress the leading module names of the typehints (e.g. " -"``io.StringIO`` -> ``StringIO``) (default)" +"``io.StringIO`` -> ``StringIO``)" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1187 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1217 msgid "The default setting was changed to ``'short'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1191 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1223 msgid "" "If True, the default argument values of functions will be not evaluated on " "generating document. It preserves them as is in the source code." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1196 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1228 msgid "" "Added as an experimental feature. This will be integrated into autodoc core" " in the future." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1201 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1235 msgid "" "This value controls the behavior of :option:`sphinx-build --fail-on-warning`" " during importing modules. If ``False`` is given, autodoc forcedly " -"suppresses the error if the imported module emits warnings. By default, " -"``True``." +"suppresses the error if the imported module emits warnings." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1206 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1240 msgid "" "This option now has no effect as :option:`!--fail-on-warning` no longer " "exits early." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1212 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1248 msgid "" "This value controls the docstrings inheritance. If set to True the docstring" " for classes or methods, if not explicitly set, is inherited from parents." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1216 -msgid "The default is ``True``." -msgstr "" - -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1223 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1259 msgid "" -":mod:`autodoc` supports to suppress warning messages via " -":confval:`suppress_warnings`. It allows following warnings types in " -"addition:" +":mod:`autodoc` supports suppressing warning messages via " +":confval:`suppress_warnings`. It defines the following additional warnings " +"types:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1227 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1263 msgid "autodoc" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1228 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1264 msgid "autodoc.import_object" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1232 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1268 msgid "Docstring preprocessing" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1234 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1270 msgid "autodoc provides the following additional events:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1240 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1276 msgid "" "Emitted when autodoc has read and processed a docstring. *lines* is a list " "of strings -- the lines of the processed docstring -- that the event handler" @@ -1099,41 +1154,40 @@ msgstr "" msgid "Parameters" msgstr "매개 변수" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1244 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1263 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1275 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1304 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1336 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1280 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1299 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1311 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1340 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1372 msgid "the Sphinx application object" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1245 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1276 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1337 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1281 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1312 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1373 msgid "" -"the type of the object which the docstring belongs to (one of " -"``\"module\"``, ``\"class\"``, ``\"exception\"``, ``\"function\"``, " -"``\"method\"``, ``\"attribute\"``)" +"the type of the object which the docstring belongs to (one of ``'module'``, " +"``'class'``, ``'exception'``, ``'function'``, ``'method'``, ``'attribute'``)" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1248 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1279 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1305 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1340 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1284 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1315 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1341 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1376 msgid "the fully qualified name of the object" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1249 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1264 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1280 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1306 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1341 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1285 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1300 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1316 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1342 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1377 msgid "the object itself" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1250 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1281 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1344 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1286 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1317 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1380 msgid "" "the options given to the directive: an object with attributes " "``inherited_members``, ``undoc_members``, ``show_inheritance`` and ``no-" @@ -1141,41 +1195,41 @@ msgid "" "directive" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1254 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1290 msgid "the lines of the docstring, see above" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1260 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1296 msgid "" "Emitted before autodoc formats a signature for an object. The event handler " "can modify an object to change its signature." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1265 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1301 msgid "a boolean indicates an object is bound method or not" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1271 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1307 msgid "" "Emitted when autodoc has formatted a signature for an object. The event " "handler can return a new tuple ``(signature, return_annotation)`` to change " "what Sphinx puts into the output." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1285 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1321 msgid "" -"function signature, as a string of the form ``\"(parameter_1, " -"parameter_2)\"``, or ``None`` if introspection didn't succeed and signature " +"function signature, as a string of the form ``'(parameter_1, " +"parameter_2)'``, or ``None`` if introspection didn't succeed and signature " "wasn't specified in the directive." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1288 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1324 msgid "" -"function return annotation as a string of the form ``\" -> annotation\"``, " -"or ``None`` if there is no return annotation" +"function return annotation as a string of the form ``' -> annotation'``, or " +"``None`` if there is no return annotation" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1291 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1327 msgid "" "The :mod:`sphinx.ext.autodoc` module provides factory functions for commonly" " needed docstring processing in event :event:`autodoc-process-docstring`:" @@ -1216,7 +1270,7 @@ msgid "" " be processed." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1299 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1335 msgid "" "Emitted when autodoc has read and processed a class to determine the base-" "classes. *bases* is a list of classes that the event handler can modify " @@ -1224,38 +1278,38 @@ msgid "" "if ``show-inheritance`` option given." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1307 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1343 msgid "the options given to the class directive" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1308 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1344 msgid "the list of base classes signature. see above." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1313 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1349 msgid "" "``bases`` can contain a string as a base class name. It will be processed as" " reStructuredText." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1318 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1354 msgid "Skipping members" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1320 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1356 msgid "" "autodoc allows the user to define a custom method for determining whether a " "member should be included in the documentation by using the following event:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1327 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1363 msgid "" "Emitted when autodoc has to decide whether a member should be included in " "the documentation. The member is excluded if a handler returns ``True``. " "It is included if the handler returns ``False``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1331 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1367 msgid "" "If more than one enabled extension handles the ``autodoc-skip-member`` " "event, autodoc will use the first non-``None`` value returned by a handler. " @@ -1263,7 +1317,7 @@ msgid "" "autodoc and other enabled extensions." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1342 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1378 msgid "" "a boolean indicating if autodoc will skip this member if the user handler " "does not override the decision" diff --git a/locale/pl_PL/LC_MESSAGES/changes/1.8.po b/locale/pl_PL/LC_MESSAGES/changes/1.8.po index 40be825955..f0849bc0b8 100644 --- a/locale/pl_PL/LC_MESSAGES/changes/1.8.po +++ b/locale/pl_PL/LC_MESSAGES/changes/1.8.po @@ -11,7 +11,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-10-01 00:54+0000\n" +"POT-Creation-Date: 2024-10-03 00:49+0000\n" "PO-Revision-Date: 2024-07-31 00:36+0000\n" "Last-Translator: Maciej Olko , 2024\n" "Language-Team: Polish (Poland) (https://app.transifex.com/sphinx-doc/teams/15434/pl_PL/)\n" @@ -400,7 +400,7 @@ msgstr "" #: ../../sphinx/doc/changes/1.8.rst:150 msgid "" "#5421: autodoc emits deprecation warning for " -":confval:`autodoc_default_flags`" +":confval:`!autodoc_default_flags`" msgstr "" #: ../../sphinx/doc/changes/1.8.rst:151 @@ -668,7 +668,7 @@ msgid ":confval:`!source_parsers` is deprecated" msgstr "" #: ../../sphinx/doc/changes/1.8.rst:254 -msgid ":confval:`autodoc_default_flags` is deprecated" +msgid ":confval:`!autodoc_default_flags` is deprecated" msgstr "" #: ../../sphinx/doc/changes/1.8.rst:255 diff --git a/locale/pl_PL/LC_MESSAGES/changes/index.po b/locale/pl_PL/LC_MESSAGES/changes/index.po index ea7d3d7be4..94a5a0a987 100644 --- a/locale/pl_PL/LC_MESSAGES/changes/index.po +++ b/locale/pl_PL/LC_MESSAGES/changes/index.po @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-09-28 00:48+0000\n" +"POT-Creation-Date: 2024-10-03 00:49+0000\n" "PO-Revision-Date: 2024-07-31 00:36+0000\n" "Language-Team: Polish (Poland) (https://app.transifex.com/sphinx-doc/teams/15434/pl_PL/)\n" "MIME-Version: 1.0\n" @@ -234,11 +234,18 @@ msgid "" ":rst:dir:`py:module` directives. Patch by Stephen Finucane." msgstr "" -#: ../../sphinx/CHANGES.rst:112 +#: ../../sphinx/CHANGES.rst:110 +msgid "" +"#12916: Restore support for custom templates named with the legacy ``_t`` " +"suffix during ``apidoc`` RST rendering (regression in 7.4.0). Patch by James" +" Addison." +msgstr "" + +#: ../../sphinx/CHANGES.rst:115 msgid "Testing" msgstr "" -#: ../../sphinx/CHANGES.rst:114 +#: ../../sphinx/CHANGES.rst:117 msgid "" "#12141: Migrate from the deprecated ``karma`` JavaScript test framework to " "the actively-maintained ``jasmine`` framework. Test coverage is unaffected." diff --git a/locale/pl_PL/LC_MESSAGES/extdev/deprecated.po b/locale/pl_PL/LC_MESSAGES/extdev/deprecated.po index a76446ff10..3c3f1ba7ea 100644 --- a/locale/pl_PL/LC_MESSAGES/extdev/deprecated.po +++ b/locale/pl_PL/LC_MESSAGES/extdev/deprecated.po @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-09-02 00:47+0000\n" +"POT-Creation-Date: 2024-10-03 00:50+0000\n" "PO-Revision-Date: 2019-03-09 18:04+0000\n" "Language-Team: Polish (Poland) (https://app.transifex.com/sphinx-doc/teams/15434/pl_PL/)\n" "MIME-Version: 1.0\n" @@ -2848,7 +2848,7 @@ msgid ":meth:`~sphinx.application.Sphinx.add_js_file`" msgstr "" #: ../../sphinx/doc/extdev/deprecated.rst:1457 -msgid ":confval:`autodoc_default_flags`" +msgid ":confval:`!autodoc_default_flags`" msgstr "" #: ../../sphinx/doc/extdev/deprecated.rst:1460 diff --git a/locale/pl_PL/LC_MESSAGES/usage/domains/restructuredtext.po b/locale/pl_PL/LC_MESSAGES/usage/domains/restructuredtext.po index df4c9fb82c..17bd5888f6 100644 --- a/locale/pl_PL/LC_MESSAGES/usage/domains/restructuredtext.po +++ b/locale/pl_PL/LC_MESSAGES/usage/domains/restructuredtext.po @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-09-15 00:53+0000\n" +"POT-Creation-Date: 2024-10-03 00:49+0000\n" "PO-Revision-Date: 2023-10-03 00:37+0000\n" "Language-Team: Polish (Poland) (https://app.transifex.com/sphinx-doc/teams/15434/pl_PL/)\n" "MIME-Version: 1.0\n" @@ -75,3 +75,20 @@ msgstr "" #: ../../sphinx/doc/usage/domains/restructuredtext.rst:97 msgid "These roles are provided to refer to the described objects:" msgstr "" + +#: ../../sphinx/doc/usage/domains/restructuredtext.rst:101 +msgid "Reference directives and directive options. Examples:" +msgstr "" + +#: ../../sphinx/doc/usage/domains/restructuredtext.rst:103 +msgid "Use ``:rst:dir:`my-directive``` to reference a directive." +msgstr "" + +#: ../../sphinx/doc/usage/domains/restructuredtext.rst:104 +msgid "" +"Use ``:rst:dir:`my-directive:my-option``` to reference a directive option." +msgstr "" + +#: ../../sphinx/doc/usage/domains/restructuredtext.rst:109 +msgid "Reference a role. Example: ``:rst:role:`my-role```." +msgstr "" diff --git a/locale/pl_PL/LC_MESSAGES/usage/extensions/autodoc.po b/locale/pl_PL/LC_MESSAGES/usage/extensions/autodoc.po index 7ef0938089..5126d50311 100644 --- a/locale/pl_PL/LC_MESSAGES/usage/extensions/autodoc.po +++ b/locale/pl_PL/LC_MESSAGES/usage/extensions/autodoc.po @@ -11,7 +11,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-10-02 00:49+0000\n" +"POT-Creation-Date: 2024-10-03 00:50+0000\n" "PO-Revision-Date: 2018-06-26 15:58+0000\n" "Last-Translator: Maciej Olko , 2024\n" "Language-Team: Polish (Poland) (https://app.transifex.com/sphinx-doc/teams/15434/pl_PL/)\n" @@ -25,26 +25,26 @@ msgstr "" msgid ":mod:`sphinx.ext.autodoc` -- Include documentation from docstrings" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:12 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:15 msgid "" "This extension can import the modules you are documenting, and pull in " "documentation from docstrings in a semi-automatic way." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:17 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:20 msgid "" ":mod:`~sphinx.ext.autodoc` **imports** the modules to be documented. If any " "modules have side effects on import, these will be executed by ``autodoc`` " "when :program:`sphinx-build` is run." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:21 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:24 msgid "" "If you document scripts (as opposed to library modules), make sure that the " "main routine is protected by an ``if __name__ == '__main__'`` condition." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:25 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:28 msgid "" "For this to work, the docstrings must of course be written in correct " "reStructuredText. You can then use all of the usual Sphinx markup in the " @@ -54,7 +54,7 @@ msgid "" "auto-generated-looking pure API documentation." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:33 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:36 msgid "" "If you prefer `NumPy`_ or `Google`_ style docstrings over reStructuredText, " "you can also enable the :mod:`napoleon ` extension. " @@ -62,25 +62,25 @@ msgid "" "reStructuredText before ``autodoc`` processes them." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:43 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:46 msgid "Getting started" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:47 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:50 msgid "Setup" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:49 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:52 msgid "" "Activate the plugin by adding ``'sphinx.ext.autodoc'`` to the " ":confval:`extensions` list in :file:`conf.py`:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:61 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:64 msgid "Ensuring the code can be imported" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:63 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:66 msgid "" ":mod:`~sphinx.ext.autodoc` analyses the code and docstrings by introspection" " after **importing the modules**. For importing to work, you have to make " @@ -90,11 +90,11 @@ msgid "" "fail)." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:70 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:73 msgid "There are two ways to ensure this:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:72 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:75 msgid "" "Use an environment that contains your package and Sphinx. This can e.g. be " "your local development environment (with an editable install), or an " @@ -103,14 +103,14 @@ msgid "" "that all dependencies are available." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:78 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:81 msgid "" "It is alternatively possible to patch the Sphinx run so that it can operate " "directly on the sources; e.g. if you want to be able to do a Sphinx build " "from a source checkout." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:82 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:85 msgid "" "Patch :data:`sys.path` in :file:`conf.py` to include your source path. For " "example if you have a repository structure with :file:`doc/conf.py` and your" @@ -118,17 +118,17 @@ msgid "" "your :file:`conf.py`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:94 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:97 msgid "" "To cope with missing dependencies, specify the missing modules in the " ":confval:`autodoc_mock_imports` setting." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:99 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:102 msgid "Usage" msgstr "Użycie" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:101 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:104 msgid "" "You can now use the :ref:`autodoc-directives` to add formatted documentation" " for Python code elements like functions, classes, modules, etc. For " @@ -136,48 +136,48 @@ msgid "" "docstring from the source file, you'd write:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:110 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:113 msgid "" "You can also document whole classes or even modules automatically, using " "member options for the auto directives, like:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:119 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:122 msgid "" "As a hint to autodoc extension, you can put a ``::`` separator between the " "module name and the object name to let autodoc know the correct module, if " "it is ambiguous:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:129 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:132 msgid "Marking objects as public or private" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:131 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:134 msgid "" "autodoc considers a member private if its docstring contains ``:meta " "private:`` in its :ref:`info-field-lists`. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:145 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:148 msgid "" "autodoc considers a member public if its docstring contains ``:meta " "public:`` in its :ref:`info-field-lists`, even if it starts with an " "underscore. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:160 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:163 msgid "" "autodoc considers a variable member does not have any default value if its " "docstring contains ``:meta hide-value:`` in its :ref:`info-field-lists`. " "Example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:174 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:177 msgid "Doc comments and docstrings" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:176 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:179 msgid "" "Python has no built-in support for docstrings for module data members or " "class attributes. To allow documenting these, ``autodoc`` recognises a " @@ -185,7 +185,7 @@ msgid "" " 'documentation comment'." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:181 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:184 msgid "" "These comments start with a colon and an optional space character, ``'#:'`` " "or ``'#: '``. To be recognised, the comments must appear either on the same " @@ -194,28 +194,28 @@ msgid "" "definition." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:188 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:191 msgid "" "For example, all three of the following variables have valid doc-comments:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:202 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:205 msgid "" "Alternatively, ``autodoc`` can recognise a docstring on the line immediately" " following the definition." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:205 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:208 msgid "" "In the the following class definition, all attributes have documentation " "recognised by ``autodoc``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:233 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:236 msgid "Directives" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:235 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:238 msgid "" ":mod:`autodoc` provides several directives that are versions of the usual " ":rst:dir:`py:module`, :rst:dir:`py:class` and so forth. On parsing time, " @@ -224,24 +224,24 @@ msgid "" ":rst:dir:`py:module`, :rst:dir:`py:class` etc. directive." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:244 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:247 msgid "" "Just as :rst:dir:`py:class` respects the current :rst:dir:`py:module`, " ":rst:dir:`autoclass` will also do so. Likewise, :rst:dir:`automethod` will " "respect the current :rst:dir:`py:class`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:250 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:253 msgid "Default directive options" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:252 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:255 msgid "" "To make any of the options described below the default, use the " ":confval:`autodoc_default_options` dictionary in :file:`conf.py`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:255 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:258 msgid "" "If using defaults for the ``:members:``, ``:exclude-members:``, ``:private-" "members:``, or ``:special-members:`` options, setting the option on a " @@ -250,111 +250,111 @@ msgid "" "(``+``), as follows:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:269 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:272 msgid "" "If using :confval:`autodoc_default_options`, the defaults can be disabled " "per-directive with the negated form, :samp:`:no-{option}:` as an option of " "the directive For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:281 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:284 msgid "Automatically document modules" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:285 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:288 msgid "" "Document a module. By default, the directive only inserts the docstring of " "the module itself:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:292 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:526 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:792 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:866 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:295 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:531 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:797 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:871 msgid "will produce source like this:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:300 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:534 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:303 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:539 msgid "" "The directive can also contain content of its own, which will be inserted " "into the resulting non-auto directive source after the docstring (but before" " any automatic member documentation)." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:304 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:538 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:878 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:307 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:543 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:883 msgid "" "Therefore, you can also mix automatic and non-automatic member " "documentation, as follows:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:317 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:567 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:844 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:894 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:320 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:572 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:849 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:899 msgid "Options" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:321 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:324 msgid "" "Do not generate an index entry for the documented module or any auto-" "documented members." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:329 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:332 msgid "" "Indicate platforms on which the module is available. This is identical to " ":rst:dir:`py:module`'s ``:platform:`` option." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:335 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:338 msgid "" "A sentence describing the module's purpose. This is identical to " ":rst:dir:`py:module`'s ``:synopsis:`` option." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:343 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:346 msgid "" "Mark a module as deprecated. This is identical to :rst:dir:`py:module`'s " "``:deprecated:`` option." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:351 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:354 msgid "Do not use ``__all__`` when analysing the module to document." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:356 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:600 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:359 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:605 msgid "Options for selecting members to document" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:360 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:363 msgid "Generate automatic documentation for all members of the target module:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:367 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:370 msgid "" "By default, ``autodoc`` only includes public members with a docstring or " ":ref:`doc-comment ` (``#:``). If ``__all__`` exists, it will be" -" used to define which members are public, unless the ``:ignore-module-all:``" -" option is set." +" used to define which members are public, unless the :rst:dir:`:ignore-" +"module-all: ` option is set." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:372 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:615 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:376 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:620 msgid "" "To only document certain members, an explicit comma-separated list may be " "used as the argument to ``:members:``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:383 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:626 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:387 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:631 msgid "Exclude the given names from the members to document. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:397 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:401 msgid "" "To prevent documentation of imported classes or functions, in an " ":rst:dir:`!automodule` directive with the ``members`` option set, only " @@ -362,198 +362,197 @@ msgid "" "name given to ``automodule`` will be documented." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:402 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:406 msgid "" "Set the ``imported-members`` option if you want to prevent this behavior and" " document all available members." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:405 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:409 msgid "" "Note that attributes from imported modules will not be documented, because " "attribute documentation is discovered by parsing the source file of the " "current module." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:414 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:418 msgid "" "Generate automatic documentation for members of the target module that don't" " have a docstring or doc-comment. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:427 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:431 msgid "" "Generate automatic documentation for private members of the target module. " "This includes names with a leading underscore (e.g. ``_private``) and those " "members explicitly marked as private with ``:meta private:``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:437 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:703 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:441 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:708 msgid "" "To only document certain private members, an explicit comma-separated list " "may be used as the argument to ``:private-members:``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:447 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:475 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:741 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:451 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:479 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:746 msgid "The option can now take a comma-separated list of arguments." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:453 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:457 msgid "" "Generate automatic documentation for special members of the target module, " -"also known as :ref:`\"dunder\" names `. This includes " -"all names enclosed with a double-underscore, e.g. ``__special__``:" +"also known as :ref:`'dunder' names `. This includes all" +" names enclosed with a double-underscore, e.g. ``__special__``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:464 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:730 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:468 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:735 msgid "" "To only document certain special members, an explicit comma-separated list " "may be used as the argument to ``:special-members:``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:479 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:745 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:483 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:750 msgid "Options for documented members" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:483 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:749 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:487 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:754 msgid "" "Choose the ordering of automatically documented members (default: " "``alphabetical``). This overrides the :confval:`autodoc_member_order` " "setting." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:487 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:491 msgid "``alphabetical``: Use simple alphabetical order." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:489 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:493 msgid "" "``groupwise``: Group by object type (class, function, etc), use alphabetical" " order within groups." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:492 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:496 msgid "" "``bysource``: Use the order of objects in the module's source. The " "``__all__`` variable can be used to override this order." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:496 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:762 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:980 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:500 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:767 msgid "" "Note that for source order, the module must be a Python module with the " "source code available." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:500 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:766 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:504 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:771 msgid "Support the ``'bysource'`` option." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:506 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:510 msgid "" -"Enable the ``:show-inheritance:`` option for all members of the module, if " -"``:members:`` is enabled." +"Enable the :rst:dir:`:show-inheritance: ` option" +" for all members of the module, if ``:members:`` is enabled." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:513 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:518 msgid "Automatically document classes or exceptions" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:518 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:523 msgid "" -"Document a class. For exception classes, prefer ``autoexception``. By " +"Document a class. For exception classes, prefer ``.. autoexception::``. By " "default, the directive only inserts the docstring of the class itself:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:551 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:828 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:556 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:833 msgid "Advanced usage" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:552 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:829 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:557 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:834 msgid "" "It is possible to override the signature for explicitly documented callable " "objects (functions, methods, classes) with the regular syntax that will " "override the signature gained from introspection:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:562 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:839 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:567 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:844 msgid "" "This is useful if the signature from the method is hidden by a decorator." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:571 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:898 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:576 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:903 msgid "" "Do not generate an index entry for the documented class or any auto-" "documented members." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:579 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:584 msgid "" "Select which docstring will be used for the main body of the directive. This" " overrides the global value of :confval:`autoclass_content`. The possible " "values are:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:583 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:588 msgid "" "``class``: Only use the class's docstring. The :meth:`!__init__` method can " "be separately documented using the ``:members:`` option or " ":rst:dir:`automethod`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:587 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:592 msgid "``init``: Only use the docstring of the :meth:`!__init__` method." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:589 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:594 msgid "" -"``both`` Use both, appending the docstring of the :meth:`!__init__` method " +"``both``: Use both, appending the docstring of the :meth:`!__init__` method " "to the class's docstring." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:593 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:598 msgid "" "If the :meth:`!__init__` method doesn't exist or has a blank docstring, " "``autodoc`` will attempt to use the :meth:`!__new__` method's docstring, if " "it exists and is not blank." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:604 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:609 msgid "Generate automatic documentation for all members of the target class:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:611 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:616 msgid "" "By default, ``autodoc`` only includes public members with a docstring or " ":ref:`doc-comment ` (``#:``) that are attributes of the target " "class (i.e. not inherited)." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:640 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:645 msgid "" "To generate automatic documentation for members inherited from base classes," " use the ``:inherited-members:`` option:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:649 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:654 msgid "" "This can be combined with the ``:undoc-members:`` option to generate " "automatic documentation for *all* available members of the class." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:652 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:657 msgid "" "The members of classes listed in the argument to ``:inherited-members:`` are" " excluded from the automatic documentation. This defaults to " @@ -562,105 +561,105 @@ msgid "" "as the argument." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:658 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:663 msgid "" "For example; If your class ``MyList`` is derived from ``list`` class and you" " don't want to document ``list.__len__()``, you should specify a option " "``:inherited-members: list`` to avoid special members of list class." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:664 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:669 msgid "" "Should any of the inherited members use a format other than reStructuredText" " for their docstrings, there may be markup warnings or errors." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:670 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:675 msgid "" "``:inherited-members:`` now takes the name of a base class to exclude as an " "argument." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:674 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:679 msgid "A comma separated list of base class names can be used." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:680 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:685 msgid "" "Generate automatic documentation for members of the target class that don't " "have a docstring or doc-comment. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:693 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:698 msgid "" "Generate automatic documentation for private members of the target class. " "This includes names with a leading underscore (e.g. ``_private``) and those " "members explicitly marked as private with ``:meta private:``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:713 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:718 msgid "The option can now take arguments." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:719 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:724 msgid "" "Generate automatic documentation for special members of the target class, " -"also known as :ref:`\"dunder\" names `. This includes " -"all names enclosed with a double-underscore, e.g. ``__special__``:" +"also known as :ref:`'dunder' names `. This includes all" +" names enclosed with a double-underscore, e.g. ``__special__``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:753 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:758 msgid "``'alphabetical'``: Use simple alphabetical order." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:755 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:760 msgid "" "``'groupwise'``: Group by object type (class, function, etc), use " "alphabetical order within groups." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:758 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:763 msgid "" "``'bysource'``: Use the order of objects in the module's source. The " "``__all__`` variable can be used to override this order." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:772 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:777 msgid "Insert the class's base classes after the class signature." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:778 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:783 msgid "Automatically document function-like objects" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:785 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:790 msgid "" "Document a function, method, property, or decorator. By default, the " "directive only inserts the docstring of the function itself:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:800 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:874 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:805 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:879 msgid "" "The directive can also contain content of its own, which will be inserted " "into the resulting non-auto directive source after the docstring." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:804 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:809 msgid "" "Therefore, you can also mix automatic and non-automatic documentation, as " "follows:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:813 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:818 msgid ":rst:dir:`autodecorator`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:815 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:820 msgid ":rst:dir:`autoproperty`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:820 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:825 msgid "" "If you document decorated functions or methods, keep in mind that " "``autodoc`` retrieves its docstrings by importing the module and inspecting " @@ -669,30 +668,30 @@ msgid "" "the original ``__doc__`` to the new function." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:848 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:853 msgid "Do not generate an index entry for the documented function." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:854 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:859 msgid "Automatically document attributes or data" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:859 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:864 msgid "" "Document a module level variable or constant ('data') or class attribute. By" " default, the directive only inserts the docstring of the variable itself:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:887 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:892 msgid "" ":rst:dir:`autodata` and :rst:dir:`autoattribute` can now extract docstrings." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:890 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:895 msgid "Doc-comments are now allowed on the same line of an assignment." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:908 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:913 msgid "" "By default, ``autodoc`` attempts to obtain the type annotation and value of " "the variable by introspection, displaying it after the variable's name. To " @@ -700,165 +699,225 @@ msgid "" "argument to ``annotation``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:914 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:919 msgid "" "For example, if the runtime value of ``FILE_MODE`` is ``0o755``, the " "displayed value will be ``493`` (as ``oct(493) == '0o755'``). This can be " "fixed by setting ``:annotation: = 0o755``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:918 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:923 msgid "" -"If ``annotation`` is used without arguments, no value or type hint will be " -"shown for the variable." +"If ``:annotation:`` is used without arguments, no value or type hint will be" +" shown for the variable." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:925 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:930 msgid "" -"To display the type hint of the variable without a value, use the ``no-" -"value`` option. If both the ``annotation`` and ``no-value`` options are " -"used, ``no-value`` has no effect." +"To display the type hint of the variable without a value, use the ``:no-" +"value:`` option. If both the ``:annotation:`` and ``:no-value:`` options are" +" used, ``:no-value:`` has no effect." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:932 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:937 msgid "Configuration" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:934 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:939 msgid "There are also config values that you can set:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:938 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:0 +msgid "Type" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:0 +msgid "Default" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:945 msgid "" "This value selects what content will be inserted into the main body of an " ":rst:dir:`autoclass` directive. The possible values are:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:941 -msgid "``\"class\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:948 +msgid "``'class'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:942 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:949 msgid "" -"Only the class' docstring is inserted. This is the default. You can still " -"document ``__init__`` as a separate method using :rst:dir:`automethod` or " -"the ``members`` option to :rst:dir:`autoclass`." +"Only the class' docstring is inserted. You can still document ``__init__`` " +"as a separate method using :rst:dir:`automethod` or the ``members`` option " +"to :rst:dir:`autoclass`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:945 -msgid "``\"both\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:952 +msgid "``'both'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:946 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:953 msgid "" "Both the class' and the ``__init__`` method's docstring are concatenated and" " inserted." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:948 -msgid "``\"init\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:955 +msgid "``'init'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:949 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:956 msgid "Only the ``__init__`` method's docstring is inserted." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:953 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:960 msgid "" "If the class has no ``__init__`` method or if the ``__init__`` method's " "docstring is empty, but the class has a ``__new__`` method's docstring, it " "is used instead." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:961 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:970 msgid "" "This value selects how the signature will be displayed for the class defined" " by :rst:dir:`autoclass` directive. The possible values are:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:964 -msgid "``\"mixed\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:973 +msgid "``'mixed'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:965 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:974 msgid "Display the signature with the class name." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:966 -msgid "``\"separated\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:975 +msgid "``'separated'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:967 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:976 msgid "Display the signature as a method." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:969 -msgid "The default is ``\"mixed\"``." -msgstr "" - -#: ../../sphinx/doc/usage/extensions/autodoc.rst:975 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:984 msgid "" -"This value selects if automatically documented members are sorted " -"alphabetical (value ``'alphabetical'``), by member type (value " -"``'groupwise'``) or by source order (value ``'bysource'``). The default is " -"alphabetical." +"Define the order in which :rst:dir:`automodule` and :rst:dir:`autoclass` " +"members are listed. Supported values are:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:984 -msgid "Support for ``'bysource'``." +#: ../../sphinx/doc/usage/extensions/autodoc.rst:987 +msgid "``'alphabetical'``: Use alphabetical order." msgstr "" #: ../../sphinx/doc/usage/extensions/autodoc.rst:989 +msgid "``'groupwise'``: order by member type. The order is:" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:991 +msgid "for modules, exceptions, classes, functions, data" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:992 +msgid "for classes: methods, then properties and attributes" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:994 +msgid "Members are ordered alphabetically within groups." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:996 msgid "" -"This value is a list of autodoc directive flags that should be automatically" -" applied to all autodoc directives. The supported flags are ``'members'``, " -"``'undoc-members'``, ``'private-members'``, ``'special-members'``, " -"``'inherited-members'``, ``'show-inheritance'``, ``'ignore-module-all'`` and" -" ``'exclude-members'``." +"``'bysource'``: Use the order in which the members appear in the source " +"code. This requires that the module must be a Python module with the source " +"code available." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:999 -msgid "Integrated into :confval:`autodoc_default_options`." +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1002 +msgid "Support for ``'bysource'``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1003 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1009 msgid "" "The default options for autodoc directives. They are applied to all autodoc" " directives automatically. It must be a dictionary which maps option names " "to the values. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1017 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1023 msgid "" "Setting ``None`` or ``True`` to the value is equivalent to giving only the " "option name to the directives." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1020 -msgid "" -"The supported options are ``'members'``, ``'member-order'``, ``'undoc-" -"members'``, ``'private-members'``, ``'special-members'``, ``'inherited-" -"members'``, ``'show-inheritance'``, ``'ignore-module-all'``, ``'imported-" -"members'``, ``'exclude-members'``, ``'class-doc-from'`` and ``'no-value'``." +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1026 +msgid "The supported options are:" msgstr "" #: ../../sphinx/doc/usage/extensions/autodoc.rst:1028 -msgid "Accepts ``True`` as a value." +msgid "``'members'``: See :rst:dir:`automodule:members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1029 +msgid "``'undoc-members'`` See :rst:dir:`automodule:undoc-members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1030 +msgid "``'private-members'``: See :rst:dir:`automodule:private-members`." msgstr "" #: ../../sphinx/doc/usage/extensions/autodoc.rst:1031 -msgid "Added ``'imported-members'``." +msgid "``'special-members'``: See :rst:dir:`automodule:special-members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1032 +msgid "``'inherited-members'``: See :rst:dir:`autoclass:inherited-members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1033 +msgid "``'imported-members'``: See :rst:dir:`automodule:imported-members`." msgstr "" #: ../../sphinx/doc/usage/extensions/autodoc.rst:1034 -msgid "Added ``'class-doc-from'``." +msgid "``'exclude-members'``: See :rst:dir:`automodule:exclude-members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1035 +msgid "``'ignore-module-all'``: See :rst:dir:`automodule:ignore-module-all`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1036 +msgid "``'member-order'``: See :rst:dir:`automodule:member-order`." msgstr "" #: ../../sphinx/doc/usage/extensions/autodoc.rst:1037 +msgid "``'show-inheritance'``: See :rst:dir:`autoclass:show-inheritance`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1038 +msgid "``'class-doc-from'``: See :rst:dir:`autoclass:class-doc-from`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1039 +msgid "``'no-value'``: See :rst:dir:`autodata:no-value`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1043 +msgid "Accepts ``True`` as a value." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1046 +msgid "Added ``'imported-members'``." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1049 +msgid "Added ``'class-doc-from'``." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1052 msgid "Added ``'no-value'``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1042 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1059 msgid "" "Functions imported from C modules cannot be introspected, and therefore the " "signature for such functions cannot be automatically determined. However, " @@ -866,7 +925,7 @@ msgid "" "the function's docstring." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1047 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1064 msgid "" "If this boolean value is set to ``True`` (which is the default), autodoc " "will look at the first line of the docstring for functions and methods, and " @@ -874,22 +933,22 @@ msgid "" "from the docstring content." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1052 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1069 msgid "" "autodoc will continue to look for multiple signature lines, stopping at the " "first line that does not look like a signature. This is useful for declaring" " overloaded function signatures." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1059 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1076 msgid "Support overloaded signatures" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1063 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1080 msgid "Overloaded signatures do not need to be separated by a backslash" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1067 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1086 msgid "" "This value contains a list of modules to be mocked up. This is useful when " "some external dependencies are not met at build time and break the building " @@ -897,198 +956,194 @@ msgid "" "themselves and omit the sub-modules:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1076 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1095 msgid "Will mock all imports under the ``django`` package." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1080 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1099 msgid "" "This config value only requires to declare the top-level modules that should" " be mocked." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1086 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1107 msgid "" "This value controls how to represent typehints. The setting takes the " "following values:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1089 -msgid "``'signature'`` -- Show typehints in the signature (default)" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1110 +msgid "``'signature'`` -- Show typehints in the signature" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1090 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1111 msgid "" "``'description'`` -- Show typehints as content of the function or method The" " typehints of overloaded functions or methods will still be represented in " "the signature." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1093 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1114 msgid "``'none'`` -- Do not show typehints" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1094 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1115 msgid "" "``'both'`` -- Show typehints in the signature and as content of the function" " or method" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1097 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1118 msgid "" "Overloaded functions or methods will not have typehints included in the " "description because it is impossible to accurately represent all possible " "overloads as a list of parameters." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1104 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1125 msgid "New option ``'description'`` is added." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1108 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1129 msgid "New option ``'both'`` is added." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1112 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1135 msgid "" "This value controls whether the types of undocumented parameters and return " -"values are documented when ``autodoc_typehints`` is set to ``description``." +"values are documented when :confval:`autodoc_typehints` is set to " +"``'description'``. Supported values:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1115 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1140 msgid "" -"The default value is ``\"all\"``, meaning that types are documented for all " -"parameters and return values, whether they are documented or not." +"``'all'``: Types are documented for all parameters and return values, " +"whether they are documented or not." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1118 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1143 msgid "" -"When set to ``\"documented\"``, types will only be documented for a " -"parameter or a return value that is already documented by the docstring." +"``'documented'``: Types will only be documented for a parameter or a return " +"value that is already documented by the docstring." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1121 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1146 msgid "" -"With ``\"documented_params\"``, parameter types will only be annotated if " -"the parameter is documented in the docstring. The return type is always " +"``'documented_params'``: Parameter types will only be annotated if the " +"parameter is documented in the docstring. The return type is always " "annotated (except if it is ``None``)." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1129 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1155 msgid "New option ``'documented_params'`` is added." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1133 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1161 msgid "" "A dictionary for users defined `type aliases`__ that maps a type name to the" " full-qualified object name. It is used to keep type aliases not evaluated " -"in the document. Defaults to empty (``{}``)." +"in the document." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1137 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1165 msgid "" "The type aliases are only available if your program enables :pep:`Postponed " "Evaluation of Annotations (PEP 563) <563>` feature via ``from __future__ " "import annotations``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1141 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1169 msgid "For example, there is code using a type alias:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1152 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1180 msgid "" "If ``autodoc_type_aliases`` is not set, autodoc will generate internal mark-" "up from this code as following:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1161 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1189 msgid "" "If you set ``autodoc_type_aliases`` as ``{'AliasType': " "'your.module.AliasType'}``, it generates the following document internally:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1176 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1206 msgid "" "This value controls the format of typehints. The setting takes the " "following values:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1179 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1209 msgid "" "``'fully-qualified'`` -- Show the module name and its name of typehints" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1180 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1210 msgid "" "``'short'`` -- Suppress the leading module names of the typehints (e.g. " -"``io.StringIO`` -> ``StringIO``) (default)" +"``io.StringIO`` -> ``StringIO``)" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1187 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1217 msgid "The default setting was changed to ``'short'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1191 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1223 msgid "" "If True, the default argument values of functions will be not evaluated on " "generating document. It preserves them as is in the source code." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1196 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1228 msgid "" "Added as an experimental feature. This will be integrated into autodoc core" " in the future." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1201 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1235 msgid "" "This value controls the behavior of :option:`sphinx-build --fail-on-warning`" " during importing modules. If ``False`` is given, autodoc forcedly " -"suppresses the error if the imported module emits warnings. By default, " -"``True``." +"suppresses the error if the imported module emits warnings." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1206 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1240 msgid "" "This option now has no effect as :option:`!--fail-on-warning` no longer " "exits early." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1212 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1248 msgid "" "This value controls the docstrings inheritance. If set to True the docstring" " for classes or methods, if not explicitly set, is inherited from parents." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1216 -msgid "The default is ``True``." -msgstr "" - -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1223 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1259 msgid "" -":mod:`autodoc` supports to suppress warning messages via " -":confval:`suppress_warnings`. It allows following warnings types in " -"addition:" +":mod:`autodoc` supports suppressing warning messages via " +":confval:`suppress_warnings`. It defines the following additional warnings " +"types:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1227 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1263 msgid "autodoc" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1228 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1264 msgid "autodoc.import_object" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1232 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1268 msgid "Docstring preprocessing" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1234 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1270 msgid "autodoc provides the following additional events:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1240 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1276 msgid "" "Emitted when autodoc has read and processed a docstring. *lines* is a list " "of strings -- the lines of the processed docstring -- that the event handler" @@ -1099,41 +1154,40 @@ msgstr "" msgid "Parameters" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1244 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1263 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1275 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1304 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1336 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1280 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1299 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1311 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1340 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1372 msgid "the Sphinx application object" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1245 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1276 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1337 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1281 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1312 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1373 msgid "" -"the type of the object which the docstring belongs to (one of " -"``\"module\"``, ``\"class\"``, ``\"exception\"``, ``\"function\"``, " -"``\"method\"``, ``\"attribute\"``)" +"the type of the object which the docstring belongs to (one of ``'module'``, " +"``'class'``, ``'exception'``, ``'function'``, ``'method'``, ``'attribute'``)" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1248 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1279 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1305 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1340 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1284 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1315 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1341 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1376 msgid "the fully qualified name of the object" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1249 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1264 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1280 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1306 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1341 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1285 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1300 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1316 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1342 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1377 msgid "the object itself" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1250 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1281 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1344 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1286 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1317 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1380 msgid "" "the options given to the directive: an object with attributes " "``inherited_members``, ``undoc_members``, ``show_inheritance`` and ``no-" @@ -1141,41 +1195,41 @@ msgid "" "directive" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1254 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1290 msgid "the lines of the docstring, see above" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1260 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1296 msgid "" "Emitted before autodoc formats a signature for an object. The event handler " "can modify an object to change its signature." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1265 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1301 msgid "a boolean indicates an object is bound method or not" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1271 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1307 msgid "" "Emitted when autodoc has formatted a signature for an object. The event " "handler can return a new tuple ``(signature, return_annotation)`` to change " "what Sphinx puts into the output." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1285 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1321 msgid "" -"function signature, as a string of the form ``\"(parameter_1, " -"parameter_2)\"``, or ``None`` if introspection didn't succeed and signature " +"function signature, as a string of the form ``'(parameter_1, " +"parameter_2)'``, or ``None`` if introspection didn't succeed and signature " "wasn't specified in the directive." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1288 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1324 msgid "" -"function return annotation as a string of the form ``\" -> annotation\"``, " -"or ``None`` if there is no return annotation" +"function return annotation as a string of the form ``' -> annotation'``, or " +"``None`` if there is no return annotation" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1291 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1327 msgid "" "The :mod:`sphinx.ext.autodoc` module provides factory functions for commonly" " needed docstring processing in event :event:`autodoc-process-docstring`:" @@ -1216,7 +1270,7 @@ msgid "" " be processed." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1299 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1335 msgid "" "Emitted when autodoc has read and processed a class to determine the base-" "classes. *bases* is a list of classes that the event handler can modify " @@ -1224,38 +1278,38 @@ msgid "" "if ``show-inheritance`` option given." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1307 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1343 msgid "the options given to the class directive" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1308 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1344 msgid "the list of base classes signature. see above." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1313 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1349 msgid "" "``bases`` can contain a string as a base class name. It will be processed as" " reStructuredText." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1318 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1354 msgid "Skipping members" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1320 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1356 msgid "" "autodoc allows the user to define a custom method for determining whether a " "member should be included in the documentation by using the following event:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1327 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1363 msgid "" "Emitted when autodoc has to decide whether a member should be included in " "the documentation. The member is excluded if a handler returns ``True``. " "It is included if the handler returns ``False``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1331 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1367 msgid "" "If more than one enabled extension handles the ``autodoc-skip-member`` " "event, autodoc will use the first non-``None`` value returned by a handler. " @@ -1263,7 +1317,7 @@ msgid "" "autodoc and other enabled extensions." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1342 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1378 msgid "" "a boolean indicating if autodoc will skip this member if the user handler " "does not override the decision" diff --git a/locale/pot/extdev/deprecated.pot b/locale/pot/extdev/deprecated.pot index 70a6ad589c..b42f6b1055 100644 --- a/locale/pot/extdev/deprecated.pot +++ b/locale/pot/extdev/deprecated.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-09-02 00:47+0000\n" +"POT-Creation-Date: 2024-10-03 00:50+0000\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -2802,7 +2802,7 @@ msgid ":meth:`~sphinx.application.Sphinx.add_js_file`" msgstr "" #: ../../sphinx/doc/extdev/deprecated.rst:1457 -msgid ":confval:`autodoc_default_flags`" +msgid ":confval:`!autodoc_default_flags`" msgstr "" #: ../../sphinx/doc/extdev/deprecated.rst:1460 diff --git a/locale/pot/usage/extensions/autodoc.pot b/locale/pot/usage/extensions/autodoc.pot index 47e3f1af30..732c2257d6 100644 --- a/locale/pot/usage/extensions/autodoc.pot +++ b/locale/pot/usage/extensions/autodoc.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-10-02 00:49+0000\n" +"POT-Creation-Date: 2024-10-03 00:50+0000\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -20,757 +20,820 @@ msgstr "" msgid ":mod:`sphinx.ext.autodoc` -- Include documentation from docstrings" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:12 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:15 msgid "This extension can import the modules you are documenting, and pull in documentation from docstrings in a semi-automatic way." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:17 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:20 msgid ":mod:`~sphinx.ext.autodoc` **imports** the modules to be documented. If any modules have side effects on import, these will be executed by ``autodoc`` when :program:`sphinx-build` is run." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:21 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:24 msgid "If you document scripts (as opposed to library modules), make sure that the main routine is protected by an ``if __name__ == '__main__'`` condition." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:25 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:28 msgid "For this to work, the docstrings must of course be written in correct reStructuredText. You can then use all of the usual Sphinx markup in the docstrings, and it will end up correctly in the documentation. Together with hand-written documentation, this technique eases the pain of having to maintain two locations for documentation, while at the same time avoiding auto-generated-looking pure API documentation." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:33 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:36 msgid "If you prefer `NumPy`_ or `Google`_ style docstrings over reStructuredText, you can also enable the :mod:`napoleon ` extension. :mod:`!napoleon` is a preprocessor that converts docstrings to correct reStructuredText before ``autodoc`` processes them." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:43 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:46 msgid "Getting started" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:47 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:50 msgid "Setup" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:49 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:52 msgid "Activate the plugin by adding ``'sphinx.ext.autodoc'`` to the :confval:`extensions` list in :file:`conf.py`:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:61 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:64 msgid "Ensuring the code can be imported" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:63 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:66 msgid ":mod:`~sphinx.ext.autodoc` analyses the code and docstrings by introspection after **importing the modules**. For importing to work, you have to make sure that your modules can be found by Sphinx and that dependencies can be resolved (if your module does ``import foo``, but ``foo`` is not available in the python environment that Sphinx runs in, your module import will fail)." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:70 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:73 msgid "There are two ways to ensure this:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:72 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:75 msgid "Use an environment that contains your package and Sphinx. This can e.g. be your local development environment (with an editable install), or an environment in CI in which you install Sphinx and your package. The regular installation process ensures that your package can be found by Sphinx and that all dependencies are available." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:78 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:81 msgid "It is alternatively possible to patch the Sphinx run so that it can operate directly on the sources; e.g. if you want to be able to do a Sphinx build from a source checkout." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:82 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:85 msgid "Patch :data:`sys.path` in :file:`conf.py` to include your source path. For example if you have a repository structure with :file:`doc/conf.py` and your package is at :file:`src/my_package`, then you should add the following to your :file:`conf.py`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:94 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:97 msgid "To cope with missing dependencies, specify the missing modules in the :confval:`autodoc_mock_imports` setting." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:99 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:102 msgid "Usage" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:101 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:104 msgid "You can now use the :ref:`autodoc-directives` to add formatted documentation for Python code elements like functions, classes, modules, etc. For example, to document the function ``io.open()``, reading its signature and docstring from the source file, you'd write:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:110 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:113 msgid "You can also document whole classes or even modules automatically, using member options for the auto directives, like:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:119 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:122 msgid "As a hint to autodoc extension, you can put a ``::`` separator between the module name and the object name to let autodoc know the correct module, if it is ambiguous:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:129 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:132 msgid "Marking objects as public or private" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:131 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:134 msgid "autodoc considers a member private if its docstring contains ``:meta private:`` in its :ref:`info-field-lists`. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:145 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:148 msgid "autodoc considers a member public if its docstring contains ``:meta public:`` in its :ref:`info-field-lists`, even if it starts with an underscore. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:160 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:163 msgid "autodoc considers a variable member does not have any default value if its docstring contains ``:meta hide-value:`` in its :ref:`info-field-lists`. Example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:174 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:177 msgid "Doc comments and docstrings" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:176 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:179 msgid "Python has no built-in support for docstrings for module data members or class attributes. To allow documenting these, ``autodoc`` recognises a special format of :ref:`comment ` called a 'doc comment' or 'documentation comment'." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:181 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:184 msgid "These comments start with a colon and an optional space character, ``'#:'`` or ``'#: '``. To be recognised, the comments must appear either on the same line as the variable or on one or more lines before the variable. Multi-line doc-comments must always appear on the lines before the variable's definition." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:188 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:191 msgid "For example, all three of the following variables have valid doc-comments:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:202 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:205 msgid "Alternatively, ``autodoc`` can recognise a docstring on the line immediately following the definition." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:205 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:208 msgid "In the the following class definition, all attributes have documentation recognised by ``autodoc``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:233 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:236 msgid "Directives" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:235 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:238 msgid ":mod:`autodoc` provides several directives that are versions of the usual :rst:dir:`py:module`, :rst:dir:`py:class` and so forth. On parsing time, they import the corresponding module and extract the docstring of the given objects, inserting them into the page source under a suitable :rst:dir:`py:module`, :rst:dir:`py:class` etc. directive." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:244 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:247 msgid "Just as :rst:dir:`py:class` respects the current :rst:dir:`py:module`, :rst:dir:`autoclass` will also do so. Likewise, :rst:dir:`automethod` will respect the current :rst:dir:`py:class`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:250 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:253 msgid "Default directive options" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:252 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:255 msgid "To make any of the options described below the default, use the :confval:`autodoc_default_options` dictionary in :file:`conf.py`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:255 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:258 msgid "If using defaults for the ``:members:``, ``:exclude-members:``, ``:private-members:``, or ``:special-members:`` options, setting the option on a directive will override the default. Instead, to extend the default list with the per-directive option, the list may be prepended with a plus sign (``+``), as follows:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:269 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:272 msgid "If using :confval:`autodoc_default_options`, the defaults can be disabled per-directive with the negated form, :samp:`:no-{option}:` as an option of the directive For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:281 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:284 msgid "Automatically document modules" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:285 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:288 msgid "Document a module. By default, the directive only inserts the docstring of the module itself:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:292 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:526 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:792 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:866 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:295 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:531 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:797 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:871 msgid "will produce source like this:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:300 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:534 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:303 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:539 msgid "The directive can also contain content of its own, which will be inserted into the resulting non-auto directive source after the docstring (but before any automatic member documentation)." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:304 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:538 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:878 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:307 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:543 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:883 msgid "Therefore, you can also mix automatic and non-automatic member documentation, as follows:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:317 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:567 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:844 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:894 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:320 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:572 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:849 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:899 msgid "Options" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:321 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:324 msgid "Do not generate an index entry for the documented module or any auto-documented members." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:329 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:332 msgid "Indicate platforms on which the module is available. This is identical to :rst:dir:`py:module`'s ``:platform:`` option." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:335 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:338 msgid "A sentence describing the module's purpose. This is identical to :rst:dir:`py:module`'s ``:synopsis:`` option." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:343 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:346 msgid "Mark a module as deprecated. This is identical to :rst:dir:`py:module`'s ``:deprecated:`` option." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:351 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:354 msgid "Do not use ``__all__`` when analysing the module to document." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:356 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:600 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:359 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:605 msgid "Options for selecting members to document" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:360 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:363 msgid "Generate automatic documentation for all members of the target module:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:367 -msgid "By default, ``autodoc`` only includes public members with a docstring or :ref:`doc-comment ` (``#:``). If ``__all__`` exists, it will be used to define which members are public, unless the ``:ignore-module-all:`` option is set." +#: ../../sphinx/doc/usage/extensions/autodoc.rst:370 +msgid "By default, ``autodoc`` only includes public members with a docstring or :ref:`doc-comment ` (``#:``). If ``__all__`` exists, it will be used to define which members are public, unless the :rst:dir:`:ignore-module-all: ` option is set." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:372 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:615 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:376 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:620 msgid "To only document certain members, an explicit comma-separated list may be used as the argument to ``:members:``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:383 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:626 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:387 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:631 msgid "Exclude the given names from the members to document. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:397 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:401 msgid "To prevent documentation of imported classes or functions, in an :rst:dir:`!automodule` directive with the ``members`` option set, only module members where the ``__module__`` attribute is equal to the module name given to ``automodule`` will be documented." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:402 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:406 msgid "Set the ``imported-members`` option if you want to prevent this behavior and document all available members." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:405 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:409 msgid "Note that attributes from imported modules will not be documented, because attribute documentation is discovered by parsing the source file of the current module." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:414 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:418 msgid "Generate automatic documentation for members of the target module that don't have a docstring or doc-comment. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:427 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:431 msgid "Generate automatic documentation for private members of the target module. This includes names with a leading underscore (e.g. ``_private``) and those members explicitly marked as private with ``:meta private:``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:437 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:703 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:441 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:708 msgid "To only document certain private members, an explicit comma-separated list may be used as the argument to ``:private-members:``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:447 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:475 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:741 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:451 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:479 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:746 msgid "The option can now take a comma-separated list of arguments." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:453 -msgid "Generate automatic documentation for special members of the target module, also known as :ref:`\"dunder\" names `. This includes all names enclosed with a double-underscore, e.g. ``__special__``:" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:457 +msgid "Generate automatic documentation for special members of the target module, also known as :ref:`'dunder' names `. This includes all names enclosed with a double-underscore, e.g. ``__special__``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:464 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:730 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:468 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:735 msgid "To only document certain special members, an explicit comma-separated list may be used as the argument to ``:special-members:``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:479 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:745 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:483 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:750 msgid "Options for documented members" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:483 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:749 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:487 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:754 msgid "Choose the ordering of automatically documented members (default: ``alphabetical``). This overrides the :confval:`autodoc_member_order` setting." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:487 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:491 msgid "``alphabetical``: Use simple alphabetical order." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:489 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:493 msgid "``groupwise``: Group by object type (class, function, etc), use alphabetical order within groups." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:492 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:496 msgid "``bysource``: Use the order of objects in the module's source. The ``__all__`` variable can be used to override this order." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:496 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:762 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:980 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:500 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:767 msgid "Note that for source order, the module must be a Python module with the source code available." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:500 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:766 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:504 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:771 msgid "Support the ``'bysource'`` option." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:506 -msgid "Enable the ``:show-inheritance:`` option for all members of the module, if ``:members:`` is enabled." +#: ../../sphinx/doc/usage/extensions/autodoc.rst:510 +msgid "Enable the :rst:dir:`:show-inheritance: ` option for all members of the module, if ``:members:`` is enabled." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:513 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:518 msgid "Automatically document classes or exceptions" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:518 -msgid "Document a class. For exception classes, prefer ``autoexception``. By default, the directive only inserts the docstring of the class itself:" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:523 +msgid "Document a class. For exception classes, prefer ``.. autoexception::``. By default, the directive only inserts the docstring of the class itself:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:551 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:828 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:556 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:833 msgid "Advanced usage" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:552 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:829 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:557 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:834 msgid "It is possible to override the signature for explicitly documented callable objects (functions, methods, classes) with the regular syntax that will override the signature gained from introspection:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:562 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:839 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:567 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:844 msgid "This is useful if the signature from the method is hidden by a decorator." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:571 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:898 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:576 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:903 msgid "Do not generate an index entry for the documented class or any auto-documented members." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:579 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:584 msgid "Select which docstring will be used for the main body of the directive. This overrides the global value of :confval:`autoclass_content`. The possible values are:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:583 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:588 msgid "``class``: Only use the class's docstring. The :meth:`!__init__` method can be separately documented using the ``:members:`` option or :rst:dir:`automethod`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:587 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:592 msgid "``init``: Only use the docstring of the :meth:`!__init__` method." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:589 -msgid "``both`` Use both, appending the docstring of the :meth:`!__init__` method to the class's docstring." +#: ../../sphinx/doc/usage/extensions/autodoc.rst:594 +msgid "``both``: Use both, appending the docstring of the :meth:`!__init__` method to the class's docstring." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:593 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:598 msgid "If the :meth:`!__init__` method doesn't exist or has a blank docstring, ``autodoc`` will attempt to use the :meth:`!__new__` method's docstring, if it exists and is not blank." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:604 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:609 msgid "Generate automatic documentation for all members of the target class:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:611 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:616 msgid "By default, ``autodoc`` only includes public members with a docstring or :ref:`doc-comment ` (``#:``) that are attributes of the target class (i.e. not inherited)." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:640 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:645 msgid "To generate automatic documentation for members inherited from base classes, use the ``:inherited-members:`` option:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:649 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:654 msgid "This can be combined with the ``:undoc-members:`` option to generate automatic documentation for *all* available members of the class." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:652 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:657 msgid "The members of classes listed in the argument to ``:inherited-members:`` are excluded from the automatic documentation. This defaults to :py:class:`python:object` if no argument is provided, meaning that members of the ``object`` class are not documented. To include these, use ``None`` as the argument." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:658 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:663 msgid "For example; If your class ``MyList`` is derived from ``list`` class and you don't want to document ``list.__len__()``, you should specify a option ``:inherited-members: list`` to avoid special members of list class." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:664 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:669 msgid "Should any of the inherited members use a format other than reStructuredText for their docstrings, there may be markup warnings or errors." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:670 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:675 msgid "``:inherited-members:`` now takes the name of a base class to exclude as an argument." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:674 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:679 msgid "A comma separated list of base class names can be used." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:680 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:685 msgid "Generate automatic documentation for members of the target class that don't have a docstring or doc-comment. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:693 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:698 msgid "Generate automatic documentation for private members of the target class. This includes names with a leading underscore (e.g. ``_private``) and those members explicitly marked as private with ``:meta private:``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:713 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:718 msgid "The option can now take arguments." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:719 -msgid "Generate automatic documentation for special members of the target class, also known as :ref:`\"dunder\" names `. This includes all names enclosed with a double-underscore, e.g. ``__special__``:" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:724 +msgid "Generate automatic documentation for special members of the target class, also known as :ref:`'dunder' names `. This includes all names enclosed with a double-underscore, e.g. ``__special__``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:753 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:758 msgid "``'alphabetical'``: Use simple alphabetical order." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:755 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:760 msgid "``'groupwise'``: Group by object type (class, function, etc), use alphabetical order within groups." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:758 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:763 msgid "``'bysource'``: Use the order of objects in the module's source. The ``__all__`` variable can be used to override this order." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:772 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:777 msgid "Insert the class's base classes after the class signature." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:778 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:783 msgid "Automatically document function-like objects" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:785 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:790 msgid "Document a function, method, property, or decorator. By default, the directive only inserts the docstring of the function itself:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:800 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:874 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:805 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:879 msgid "The directive can also contain content of its own, which will be inserted into the resulting non-auto directive source after the docstring." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:804 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:809 msgid "Therefore, you can also mix automatic and non-automatic documentation, as follows:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:813 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:818 msgid ":rst:dir:`autodecorator`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:815 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:820 msgid ":rst:dir:`autoproperty`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:820 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:825 msgid "If you document decorated functions or methods, keep in mind that ``autodoc`` retrieves its docstrings by importing the module and inspecting the ``__doc__`` attribute of the given function or method. That means that if a decorator replaces the decorated function with another, it must copy the original ``__doc__`` to the new function." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:848 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:853 msgid "Do not generate an index entry for the documented function." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:854 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:859 msgid "Automatically document attributes or data" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:859 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:864 msgid "Document a module level variable or constant ('data') or class attribute. By default, the directive only inserts the docstring of the variable itself:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:887 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:892 msgid ":rst:dir:`autodata` and :rst:dir:`autoattribute` can now extract docstrings." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:890 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:895 msgid "Doc-comments are now allowed on the same line of an assignment." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:908 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:913 msgid "By default, ``autodoc`` attempts to obtain the type annotation and value of the variable by introspection, displaying it after the variable's name. To override this, a custom string for the variable's value may be used as the argument to ``annotation``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:914 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:919 msgid "For example, if the runtime value of ``FILE_MODE`` is ``0o755``, the displayed value will be ``493`` (as ``oct(493) == '0o755'``). This can be fixed by setting ``:annotation: = 0o755``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:918 -msgid "If ``annotation`` is used without arguments, no value or type hint will be shown for the variable." +#: ../../sphinx/doc/usage/extensions/autodoc.rst:923 +msgid "If ``:annotation:`` is used without arguments, no value or type hint will be shown for the variable." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:925 -msgid "To display the type hint of the variable without a value, use the ``no-value`` option. If both the ``annotation`` and ``no-value`` options are used, ``no-value`` has no effect." +#: ../../sphinx/doc/usage/extensions/autodoc.rst:930 +msgid "To display the type hint of the variable without a value, use the ``:no-value:`` option. If both the ``:annotation:`` and ``:no-value:`` options are used, ``:no-value:`` has no effect." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:932 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:937 msgid "Configuration" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:934 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:939 msgid "There are also config values that you can set:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:938 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:0 +msgid "Type" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:0 +msgid "Default" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:945 msgid "This value selects what content will be inserted into the main body of an :rst:dir:`autoclass` directive. The possible values are:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:941 -msgid "``\"class\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:948 +msgid "``'class'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:942 -msgid "Only the class' docstring is inserted. This is the default. You can still document ``__init__`` as a separate method using :rst:dir:`automethod` or the ``members`` option to :rst:dir:`autoclass`." +#: ../../sphinx/doc/usage/extensions/autodoc.rst:949 +msgid "Only the class' docstring is inserted. You can still document ``__init__`` as a separate method using :rst:dir:`automethod` or the ``members`` option to :rst:dir:`autoclass`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:945 -msgid "``\"both\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:952 +msgid "``'both'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:946 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:953 msgid "Both the class' and the ``__init__`` method's docstring are concatenated and inserted." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:948 -msgid "``\"init\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:955 +msgid "``'init'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:949 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:956 msgid "Only the ``__init__`` method's docstring is inserted." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:953 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:960 msgid "If the class has no ``__init__`` method or if the ``__init__`` method's docstring is empty, but the class has a ``__new__`` method's docstring, it is used instead." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:961 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:970 msgid "This value selects how the signature will be displayed for the class defined by :rst:dir:`autoclass` directive. The possible values are:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:964 -msgid "``\"mixed\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:973 +msgid "``'mixed'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:965 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:974 msgid "Display the signature with the class name." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:966 -msgid "``\"separated\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:975 +msgid "``'separated'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:967 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:976 msgid "Display the signature as a method." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:969 -msgid "The default is ``\"mixed\"``." +#: ../../sphinx/doc/usage/extensions/autodoc.rst:984 +msgid "Define the order in which :rst:dir:`automodule` and :rst:dir:`autoclass` members are listed. Supported values are:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:975 -msgid "This value selects if automatically documented members are sorted alphabetical (value ``'alphabetical'``), by member type (value ``'groupwise'``) or by source order (value ``'bysource'``). The default is alphabetical." +#: ../../sphinx/doc/usage/extensions/autodoc.rst:987 +msgid "``'alphabetical'``: Use alphabetical order." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:984 -msgid "Support for ``'bysource'``." +#: ../../sphinx/doc/usage/extensions/autodoc.rst:989 +msgid "``'groupwise'``: order by member type. The order is:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:989 -msgid "This value is a list of autodoc directive flags that should be automatically applied to all autodoc directives. The supported flags are ``'members'``, ``'undoc-members'``, ``'private-members'``, ``'special-members'``, ``'inherited-members'``, ``'show-inheritance'``, ``'ignore-module-all'`` and ``'exclude-members'``." +#: ../../sphinx/doc/usage/extensions/autodoc.rst:991 +msgid "for modules, exceptions, classes, functions, data" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:999 -msgid "Integrated into :confval:`autodoc_default_options`." +#: ../../sphinx/doc/usage/extensions/autodoc.rst:992 +msgid "for classes: methods, then properties and attributes" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:994 +msgid "Members are ordered alphabetically within groups." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:996 +msgid "``'bysource'``: Use the order in which the members appear in the source code. This requires that the module must be a Python module with the source code available." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1002 +msgid "Support for ``'bysource'``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1003 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1009 msgid "The default options for autodoc directives. They are applied to all autodoc directives automatically. It must be a dictionary which maps option names to the values. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1017 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1023 msgid "Setting ``None`` or ``True`` to the value is equivalent to giving only the option name to the directives." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1020 -msgid "The supported options are ``'members'``, ``'member-order'``, ``'undoc-members'``, ``'private-members'``, ``'special-members'``, ``'inherited-members'``, ``'show-inheritance'``, ``'ignore-module-all'``, ``'imported-members'``, ``'exclude-members'``, ``'class-doc-from'`` and ``'no-value'``." +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1026 +msgid "The supported options are:" msgstr "" #: ../../sphinx/doc/usage/extensions/autodoc.rst:1028 -msgid "Accepts ``True`` as a value." +msgid "``'members'``: See :rst:dir:`automodule:members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1029 +msgid "``'undoc-members'`` See :rst:dir:`automodule:undoc-members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1030 +msgid "``'private-members'``: See :rst:dir:`automodule:private-members`." msgstr "" #: ../../sphinx/doc/usage/extensions/autodoc.rst:1031 -msgid "Added ``'imported-members'``." +msgid "``'special-members'``: See :rst:dir:`automodule:special-members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1032 +msgid "``'inherited-members'``: See :rst:dir:`autoclass:inherited-members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1033 +msgid "``'imported-members'``: See :rst:dir:`automodule:imported-members`." msgstr "" #: ../../sphinx/doc/usage/extensions/autodoc.rst:1034 -msgid "Added ``'class-doc-from'``." +msgid "``'exclude-members'``: See :rst:dir:`automodule:exclude-members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1035 +msgid "``'ignore-module-all'``: See :rst:dir:`automodule:ignore-module-all`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1036 +msgid "``'member-order'``: See :rst:dir:`automodule:member-order`." msgstr "" #: ../../sphinx/doc/usage/extensions/autodoc.rst:1037 +msgid "``'show-inheritance'``: See :rst:dir:`autoclass:show-inheritance`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1038 +msgid "``'class-doc-from'``: See :rst:dir:`autoclass:class-doc-from`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1039 +msgid "``'no-value'``: See :rst:dir:`autodata:no-value`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1043 +msgid "Accepts ``True`` as a value." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1046 +msgid "Added ``'imported-members'``." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1049 +msgid "Added ``'class-doc-from'``." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1052 msgid "Added ``'no-value'``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1042 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1059 msgid "Functions imported from C modules cannot be introspected, and therefore the signature for such functions cannot be automatically determined. However, it is an often-used convention to put the signature into the first line of the function's docstring." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1047 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1064 msgid "If this boolean value is set to ``True`` (which is the default), autodoc will look at the first line of the docstring for functions and methods, and if it looks like a signature, use the line as the signature and remove it from the docstring content." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1052 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1069 msgid "autodoc will continue to look for multiple signature lines, stopping at the first line that does not look like a signature. This is useful for declaring overloaded function signatures." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1059 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1076 msgid "Support overloaded signatures" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1063 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1080 msgid "Overloaded signatures do not need to be separated by a backslash" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1067 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1086 msgid "This value contains a list of modules to be mocked up. This is useful when some external dependencies are not met at build time and break the building process. You may only specify the root package of the dependencies themselves and omit the sub-modules:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1076 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1095 msgid "Will mock all imports under the ``django`` package." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1080 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1099 msgid "This config value only requires to declare the top-level modules that should be mocked." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1086 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1107 msgid "This value controls how to represent typehints. The setting takes the following values:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1089 -msgid "``'signature'`` -- Show typehints in the signature (default)" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1110 +msgid "``'signature'`` -- Show typehints in the signature" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1090 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1111 msgid "``'description'`` -- Show typehints as content of the function or method The typehints of overloaded functions or methods will still be represented in the signature." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1093 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1114 msgid "``'none'`` -- Do not show typehints" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1094 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1115 msgid "``'both'`` -- Show typehints in the signature and as content of the function or method" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1097 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1118 msgid "Overloaded functions or methods will not have typehints included in the description because it is impossible to accurately represent all possible overloads as a list of parameters." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1104 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1125 msgid "New option ``'description'`` is added." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1108 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1129 msgid "New option ``'both'`` is added." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1112 -msgid "This value controls whether the types of undocumented parameters and return values are documented when ``autodoc_typehints`` is set to ``description``." +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1135 +msgid "This value controls whether the types of undocumented parameters and return values are documented when :confval:`autodoc_typehints` is set to ``'description'``. Supported values:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1115 -msgid "The default value is ``\"all\"``, meaning that types are documented for all parameters and return values, whether they are documented or not." +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1140 +msgid "``'all'``: Types are documented for all parameters and return values, whether they are documented or not." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1118 -msgid "When set to ``\"documented\"``, types will only be documented for a parameter or a return value that is already documented by the docstring." +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1143 +msgid "``'documented'``: Types will only be documented for a parameter or a return value that is already documented by the docstring." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1121 -msgid "With ``\"documented_params\"``, parameter types will only be annotated if the parameter is documented in the docstring. The return type is always annotated (except if it is ``None``)." +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1146 +msgid "``'documented_params'``: Parameter types will only be annotated if the parameter is documented in the docstring. The return type is always annotated (except if it is ``None``)." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1129 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1155 msgid "New option ``'documented_params'`` is added." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1133 -msgid "A dictionary for users defined `type aliases`__ that maps a type name to the full-qualified object name. It is used to keep type aliases not evaluated in the document. Defaults to empty (``{}``)." +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1161 +msgid "A dictionary for users defined `type aliases`__ that maps a type name to the full-qualified object name. It is used to keep type aliases not evaluated in the document." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1137 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1165 msgid "The type aliases are only available if your program enables :pep:`Postponed Evaluation of Annotations (PEP 563) <563>` feature via ``from __future__ import annotations``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1141 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1169 msgid "For example, there is code using a type alias:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1152 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1180 msgid "If ``autodoc_type_aliases`` is not set, autodoc will generate internal mark-up from this code as following:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1161 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1189 msgid "If you set ``autodoc_type_aliases`` as ``{'AliasType': 'your.module.AliasType'}``, it generates the following document internally:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1176 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1206 msgid "This value controls the format of typehints. The setting takes the following values:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1179 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1209 msgid "``'fully-qualified'`` -- Show the module name and its name of typehints" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1180 -msgid "``'short'`` -- Suppress the leading module names of the typehints (e.g. ``io.StringIO`` -> ``StringIO``) (default)" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1210 +msgid "``'short'`` -- Suppress the leading module names of the typehints (e.g. ``io.StringIO`` -> ``StringIO``)" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1187 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1217 msgid "The default setting was changed to ``'short'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1191 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1223 msgid "If True, the default argument values of functions will be not evaluated on generating document. It preserves them as is in the source code." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1196 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1228 msgid "Added as an experimental feature. This will be integrated into autodoc core in the future." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1201 -msgid "This value controls the behavior of :option:`sphinx-build --fail-on-warning` during importing modules. If ``False`` is given, autodoc forcedly suppresses the error if the imported module emits warnings. By default, ``True``." +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1235 +msgid "This value controls the behavior of :option:`sphinx-build --fail-on-warning` during importing modules. If ``False`` is given, autodoc forcedly suppresses the error if the imported module emits warnings." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1206 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1240 msgid "This option now has no effect as :option:`!--fail-on-warning` no longer exits early." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1212 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1248 msgid "This value controls the docstrings inheritance. If set to True the docstring for classes or methods, if not explicitly set, is inherited from parents." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1216 -msgid "The default is ``True``." +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1259 +msgid ":mod:`autodoc` supports suppressing warning messages via :confval:`suppress_warnings`. It defines the following additional warnings types:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1223 -msgid ":mod:`autodoc` supports to suppress warning messages via :confval:`suppress_warnings`. It allows following warnings types in addition:" -msgstr "" - -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1227 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1263 msgid "autodoc" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1228 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1264 msgid "autodoc.import_object" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1232 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1268 msgid "Docstring preprocessing" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1234 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1270 msgid "autodoc provides the following additional events:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1240 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1276 msgid "Emitted when autodoc has read and processed a docstring. *lines* is a list of strings -- the lines of the processed docstring -- that the event handler can modify **in place** to change what Sphinx puts into the output." msgstr "" @@ -778,66 +841,66 @@ msgstr "" msgid "Parameters" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1244 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1263 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1275 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1304 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1336 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1280 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1299 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1311 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1340 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1372 msgid "the Sphinx application object" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1245 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1276 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1337 -msgid "the type of the object which the docstring belongs to (one of ``\"module\"``, ``\"class\"``, ``\"exception\"``, ``\"function\"``, ``\"method\"``, ``\"attribute\"``)" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1281 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1312 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1373 +msgid "the type of the object which the docstring belongs to (one of ``'module'``, ``'class'``, ``'exception'``, ``'function'``, ``'method'``, ``'attribute'``)" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1248 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1279 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1305 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1340 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1284 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1315 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1341 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1376 msgid "the fully qualified name of the object" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1249 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1264 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1280 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1306 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1341 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1285 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1300 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1316 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1342 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1377 msgid "the object itself" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1250 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1281 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1344 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1286 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1317 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1380 msgid "the options given to the directive: an object with attributes ``inherited_members``, ``undoc_members``, ``show_inheritance`` and ``no-index`` that are true if the flag option of same name was given to the auto directive" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1254 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1290 msgid "the lines of the docstring, see above" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1260 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1296 msgid "Emitted before autodoc formats a signature for an object. The event handler can modify an object to change its signature." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1265 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1301 msgid "a boolean indicates an object is bound method or not" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1271 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1307 msgid "Emitted when autodoc has formatted a signature for an object. The event handler can return a new tuple ``(signature, return_annotation)`` to change what Sphinx puts into the output." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1285 -msgid "function signature, as a string of the form ``\"(parameter_1, parameter_2)\"``, or ``None`` if introspection didn't succeed and signature wasn't specified in the directive." +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1321 +msgid "function signature, as a string of the form ``'(parameter_1, parameter_2)'``, or ``None`` if introspection didn't succeed and signature wasn't specified in the directive." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1288 -msgid "function return annotation as a string of the form ``\" -> annotation\"``, or ``None`` if there is no return annotation" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1324 +msgid "function return annotation as a string of the form ``' -> annotation'``, or ``None`` if there is no return annotation" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1291 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1327 msgid "The :mod:`sphinx.ext.autodoc` module provides factory functions for commonly needed docstring processing in event :event:`autodoc-process-docstring`:" msgstr "" @@ -861,38 +924,38 @@ msgstr "" msgid "If *what* is a sequence of strings, only docstrings of a type in *what* will be processed." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1299 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1335 msgid "Emitted when autodoc has read and processed a class to determine the base-classes. *bases* is a list of classes that the event handler can modify **in place** to change what Sphinx puts into the output. It's emitted only if ``show-inheritance`` option given." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1307 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1343 msgid "the options given to the class directive" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1308 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1344 msgid "the list of base classes signature. see above." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1313 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1349 msgid "``bases`` can contain a string as a base class name. It will be processed as reStructuredText." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1318 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1354 msgid "Skipping members" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1320 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1356 msgid "autodoc allows the user to define a custom method for determining whether a member should be included in the documentation by using the following event:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1327 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1363 msgid "Emitted when autodoc has to decide whether a member should be included in the documentation. The member is excluded if a handler returns ``True``. It is included if the handler returns ``False``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1331 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1367 msgid "If more than one enabled extension handles the ``autodoc-skip-member`` event, autodoc will use the first non-``None`` value returned by a handler. Handlers should return ``None`` to fall back to the skipping behavior of autodoc and other enabled extensions." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1342 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1378 msgid "a boolean indicating if autodoc will skip this member if the user handler does not override the decision" msgstr "" diff --git a/locale/pt_BR/LC_MESSAGES/changes/1.8.po b/locale/pt_BR/LC_MESSAGES/changes/1.8.po index c501256d30..8466b3bd3b 100644 --- a/locale/pt_BR/LC_MESSAGES/changes/1.8.po +++ b/locale/pt_BR/LC_MESSAGES/changes/1.8.po @@ -13,7 +13,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-10-01 00:54+0000\n" +"POT-Creation-Date: 2024-10-03 00:49+0000\n" "PO-Revision-Date: 2024-07-31 00:36+0000\n" "Last-Translator: Rafael Fontenelle , 2024\n" "Language-Team: Portuguese (Brazil) (https://app.transifex.com/sphinx-doc/teams/15434/pt_BR/)\n" @@ -402,7 +402,7 @@ msgstr "" #: ../../sphinx/doc/changes/1.8.rst:150 msgid "" "#5421: autodoc emits deprecation warning for " -":confval:`autodoc_default_flags`" +":confval:`!autodoc_default_flags`" msgstr "" #: ../../sphinx/doc/changes/1.8.rst:151 @@ -671,8 +671,8 @@ msgid ":confval:`!source_parsers` is deprecated" msgstr "" #: ../../sphinx/doc/changes/1.8.rst:254 -msgid ":confval:`autodoc_default_flags` is deprecated" -msgstr ":confval:`autodoc_default_flags` foi descontinuado" +msgid ":confval:`!autodoc_default_flags` is deprecated" +msgstr "" #: ../../sphinx/doc/changes/1.8.rst:255 msgid "quickstart: ``--epub`` option becomes default, so it is deprecated" diff --git a/locale/pt_BR/LC_MESSAGES/changes/index.po b/locale/pt_BR/LC_MESSAGES/changes/index.po index 2da863978d..c749bb0e6a 100644 --- a/locale/pt_BR/LC_MESSAGES/changes/index.po +++ b/locale/pt_BR/LC_MESSAGES/changes/index.po @@ -12,7 +12,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-09-30 00:51+0000\n" +"POT-Creation-Date: 2024-10-03 00:49+0000\n" "PO-Revision-Date: 2024-07-31 00:36+0000\n" "Last-Translator: Rafael Fontenelle , 2024\n" "Language-Team: Portuguese (Brazil) (https://app.transifex.com/sphinx-doc/teams/15434/pt_BR/)\n" @@ -319,11 +319,18 @@ msgstr "" "#12844: Restaura o suporte a ``:noindex:`` para as diretivas " ":rst:dir:`js:module` e :rst:dir:`py:module`. Patch de Stephen Finucane." -#: ../../sphinx/CHANGES.rst:112 +#: ../../sphinx/CHANGES.rst:110 +msgid "" +"#12916: Restore support for custom templates named with the legacy ``_t`` " +"suffix during ``apidoc`` RST rendering (regression in 7.4.0). Patch by James" +" Addison." +msgstr "" + +#: ../../sphinx/CHANGES.rst:115 msgid "Testing" msgstr "Testes" -#: ../../sphinx/CHANGES.rst:114 +#: ../../sphinx/CHANGES.rst:117 msgid "" "#12141: Migrate from the deprecated ``karma`` JavaScript test framework to " "the actively-maintained ``jasmine`` framework. Test coverage is unaffected." diff --git a/locale/pt_BR/LC_MESSAGES/extdev/deprecated.po b/locale/pt_BR/LC_MESSAGES/extdev/deprecated.po index c5dc85da8d..9f034d0353 100644 --- a/locale/pt_BR/LC_MESSAGES/extdev/deprecated.po +++ b/locale/pt_BR/LC_MESSAGES/extdev/deprecated.po @@ -12,7 +12,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-09-02 00:47+0000\n" +"POT-Creation-Date: 2024-10-03 00:50+0000\n" "PO-Revision-Date: 2019-03-09 18:04+0000\n" "Last-Translator: Rafael Fontenelle , 2024\n" "Language-Team: Portuguese (Brazil) (https://app.transifex.com/sphinx-doc/teams/15434/pt_BR/)\n" @@ -2902,8 +2902,8 @@ msgid ":meth:`~sphinx.application.Sphinx.add_js_file`" msgstr ":meth:`~sphinx.application.Sphinx.add_js_file`" #: ../../sphinx/doc/extdev/deprecated.rst:1457 -msgid ":confval:`autodoc_default_flags`" -msgstr ":confval:`autodoc_default_flags`" +msgid ":confval:`!autodoc_default_flags`" +msgstr "" #: ../../sphinx/doc/extdev/deprecated.rst:1460 msgid ":confval:`autodoc_default_options`" diff --git a/locale/pt_BR/LC_MESSAGES/usage/domains/restructuredtext.po b/locale/pt_BR/LC_MESSAGES/usage/domains/restructuredtext.po index e95345687b..33e4b09488 100644 --- a/locale/pt_BR/LC_MESSAGES/usage/domains/restructuredtext.po +++ b/locale/pt_BR/LC_MESSAGES/usage/domains/restructuredtext.po @@ -12,7 +12,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-09-18 00:46+0000\n" +"POT-Creation-Date: 2024-10-03 00:49+0000\n" "PO-Revision-Date: 2023-10-03 00:37+0000\n" "Last-Translator: Rafael Fontenelle , 2024\n" "Language-Team: Portuguese (Brazil) (https://app.transifex.com/sphinx-doc/teams/15434/pt_BR/)\n" @@ -88,3 +88,20 @@ msgstr "Descreve um papel reStructuredText. Por exemplo::" msgid "These roles are provided to refer to the described objects:" msgstr "" "Essas funções são fornecidas para fazer referência aos objetos descritos:" + +#: ../../sphinx/doc/usage/domains/restructuredtext.rst:101 +msgid "Reference directives and directive options. Examples:" +msgstr "" + +#: ../../sphinx/doc/usage/domains/restructuredtext.rst:103 +msgid "Use ``:rst:dir:`my-directive``` to reference a directive." +msgstr "" + +#: ../../sphinx/doc/usage/domains/restructuredtext.rst:104 +msgid "" +"Use ``:rst:dir:`my-directive:my-option``` to reference a directive option." +msgstr "" + +#: ../../sphinx/doc/usage/domains/restructuredtext.rst:109 +msgid "Reference a role. Example: ``:rst:role:`my-role```." +msgstr "" diff --git a/locale/pt_BR/LC_MESSAGES/usage/extensions/autodoc.po b/locale/pt_BR/LC_MESSAGES/usage/extensions/autodoc.po index 93eabef845..98f7fff4ac 100644 --- a/locale/pt_BR/LC_MESSAGES/usage/extensions/autodoc.po +++ b/locale/pt_BR/LC_MESSAGES/usage/extensions/autodoc.po @@ -15,7 +15,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-10-02 00:49+0000\n" +"POT-Creation-Date: 2024-10-03 00:50+0000\n" "PO-Revision-Date: 2018-06-26 15:58+0000\n" "Last-Translator: Rafael Fontenelle , 2024\n" "Language-Team: Portuguese (Brazil) (https://app.transifex.com/sphinx-doc/teams/15434/pt_BR/)\n" @@ -29,7 +29,7 @@ msgstr "" msgid ":mod:`sphinx.ext.autodoc` -- Include documentation from docstrings" msgstr ":mod:`sphinx.ext.autodoc` - Inclui documentação das docstrings" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:12 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:15 msgid "" "This extension can import the modules you are documenting, and pull in " "documentation from docstrings in a semi-automatic way." @@ -37,20 +37,20 @@ msgstr "" "Essa extensão pode importar módulos que estão sendo documentados, e carregar" " na documentação a partir de docstrings de forma semiautomática." -#: ../../sphinx/doc/usage/extensions/autodoc.rst:17 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:20 msgid "" ":mod:`~sphinx.ext.autodoc` **imports** the modules to be documented. If any " "modules have side effects on import, these will be executed by ``autodoc`` " "when :program:`sphinx-build` is run." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:21 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:24 msgid "" "If you document scripts (as opposed to library modules), make sure that the " "main routine is protected by an ``if __name__ == '__main__'`` condition." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:25 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:28 msgid "" "For this to work, the docstrings must of course be written in correct " "reStructuredText. You can then use all of the usual Sphinx markup in the " @@ -60,7 +60,7 @@ msgid "" "auto-generated-looking pure API documentation." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:33 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:36 msgid "" "If you prefer `NumPy`_ or `Google`_ style docstrings over reStructuredText, " "you can also enable the :mod:`napoleon ` extension. " @@ -68,25 +68,25 @@ msgid "" "reStructuredText before ``autodoc`` processes them." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:43 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:46 msgid "Getting started" msgstr "Primeiros passos" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:47 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:50 msgid "Setup" msgstr "Configuração" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:49 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:52 msgid "" "Activate the plugin by adding ``'sphinx.ext.autodoc'`` to the " ":confval:`extensions` list in :file:`conf.py`:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:61 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:64 msgid "Ensuring the code can be imported" msgstr "Garantir que o código possa ser importado" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:63 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:66 msgid "" ":mod:`~sphinx.ext.autodoc` analyses the code and docstrings by introspection" " after **importing the modules**. For importing to work, you have to make " @@ -96,11 +96,11 @@ msgid "" "fail)." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:70 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:73 msgid "There are two ways to ensure this:" msgstr "Existem duas maneiras de garantir isso:" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:72 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:75 msgid "" "Use an environment that contains your package and Sphinx. This can e.g. be " "your local development environment (with an editable install), or an " @@ -109,7 +109,7 @@ msgid "" "that all dependencies are available." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:78 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:81 msgid "" "It is alternatively possible to patch the Sphinx run so that it can operate " "directly on the sources; e.g. if you want to be able to do a Sphinx build " @@ -119,7 +119,7 @@ msgstr "" "possa operar diretamente nas fontes; por exemplo, se você quiser fazer uma " "construção de Sphinx a partir de um checkout local de fontes." -#: ../../sphinx/doc/usage/extensions/autodoc.rst:82 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:85 msgid "" "Patch :data:`sys.path` in :file:`conf.py` to include your source path. For " "example if you have a repository structure with :file:`doc/conf.py` and your" @@ -127,17 +127,17 @@ msgid "" "your :file:`conf.py`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:94 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:97 msgid "" "To cope with missing dependencies, specify the missing modules in the " ":confval:`autodoc_mock_imports` setting." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:99 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:102 msgid "Usage" msgstr "Uso" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:101 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:104 msgid "" "You can now use the :ref:`autodoc-directives` to add formatted documentation" " for Python code elements like functions, classes, modules, etc. For " @@ -145,24 +145,24 @@ msgid "" "docstring from the source file, you'd write:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:110 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:113 msgid "" "You can also document whole classes or even modules automatically, using " "member options for the auto directives, like:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:119 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:122 msgid "" "As a hint to autodoc extension, you can put a ``::`` separator between the " "module name and the object name to let autodoc know the correct module, if " "it is ambiguous:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:129 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:132 msgid "Marking objects as public or private" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:131 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:134 msgid "" "autodoc considers a member private if its docstring contains ``:meta " "private:`` in its :ref:`info-field-lists`. For example:" @@ -170,7 +170,7 @@ msgstr "" "autodoc considera um membro privado se sua docstring contém ``:meta " "private:`` em sua :ref:`info-field-lists`. Por exemplo:" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:145 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:148 msgid "" "autodoc considers a member public if its docstring contains ``:meta " "public:`` in its :ref:`info-field-lists`, even if it starts with an " @@ -180,7 +180,7 @@ msgstr "" "public:`` em sua :ref:`info-field-lists`, mesmo se começar com um " "sublinhado. Por exemplo:" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:160 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:163 msgid "" "autodoc considers a variable member does not have any default value if its " "docstring contains ``:meta hide-value:`` in its :ref:`info-field-lists`. " @@ -190,11 +190,11 @@ msgstr "" "docstring contém ``:meta hide-value:`` em sua :ref:`info-field-lists`. " "Exemplo:" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:174 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:177 msgid "Doc comments and docstrings" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:176 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:179 msgid "" "Python has no built-in support for docstrings for module data members or " "class attributes. To allow documenting these, ``autodoc`` recognises a " @@ -202,7 +202,7 @@ msgid "" " 'documentation comment'." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:181 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:184 msgid "" "These comments start with a colon and an optional space character, ``'#:'`` " "or ``'#: '``. To be recognised, the comments must appear either on the same " @@ -211,28 +211,28 @@ msgid "" "definition." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:188 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:191 msgid "" "For example, all three of the following variables have valid doc-comments:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:202 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:205 msgid "" "Alternatively, ``autodoc`` can recognise a docstring on the line immediately" " following the definition." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:205 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:208 msgid "" "In the the following class definition, all attributes have documentation " "recognised by ``autodoc``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:233 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:236 msgid "Directives" msgstr "Diretivas" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:235 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:238 msgid "" ":mod:`autodoc` provides several directives that are versions of the usual " ":rst:dir:`py:module`, :rst:dir:`py:class` and so forth. On parsing time, " @@ -241,24 +241,24 @@ msgid "" ":rst:dir:`py:module`, :rst:dir:`py:class` etc. directive." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:244 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:247 msgid "" "Just as :rst:dir:`py:class` respects the current :rst:dir:`py:module`, " ":rst:dir:`autoclass` will also do so. Likewise, :rst:dir:`automethod` will " "respect the current :rst:dir:`py:class`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:250 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:253 msgid "Default directive options" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:252 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:255 msgid "" "To make any of the options described below the default, use the " ":confval:`autodoc_default_options` dictionary in :file:`conf.py`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:255 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:258 msgid "" "If using defaults for the ``:members:``, ``:exclude-members:``, ``:private-" "members:``, or ``:special-members:`` options, setting the option on a " @@ -267,111 +267,111 @@ msgid "" "(``+``), as follows:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:269 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:272 msgid "" "If using :confval:`autodoc_default_options`, the defaults can be disabled " "per-directive with the negated form, :samp:`:no-{option}:` as an option of " "the directive For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:281 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:284 msgid "Automatically document modules" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:285 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:288 msgid "" "Document a module. By default, the directive only inserts the docstring of " "the module itself:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:292 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:526 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:792 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:866 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:295 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:531 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:797 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:871 msgid "will produce source like this:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:300 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:534 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:303 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:539 msgid "" "The directive can also contain content of its own, which will be inserted " "into the resulting non-auto directive source after the docstring (but before" " any automatic member documentation)." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:304 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:538 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:878 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:307 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:543 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:883 msgid "" "Therefore, you can also mix automatic and non-automatic member " "documentation, as follows:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:317 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:567 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:844 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:894 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:320 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:572 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:849 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:899 msgid "Options" msgstr "Opções" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:321 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:324 msgid "" "Do not generate an index entry for the documented module or any auto-" "documented members." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:329 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:332 msgid "" "Indicate platforms on which the module is available. This is identical to " ":rst:dir:`py:module`'s ``:platform:`` option." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:335 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:338 msgid "" "A sentence describing the module's purpose. This is identical to " ":rst:dir:`py:module`'s ``:synopsis:`` option." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:343 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:346 msgid "" "Mark a module as deprecated. This is identical to :rst:dir:`py:module`'s " "``:deprecated:`` option." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:351 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:354 msgid "Do not use ``__all__`` when analysing the module to document." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:356 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:600 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:359 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:605 msgid "Options for selecting members to document" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:360 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:363 msgid "Generate automatic documentation for all members of the target module:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:367 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:370 msgid "" "By default, ``autodoc`` only includes public members with a docstring or " ":ref:`doc-comment ` (``#:``). If ``__all__`` exists, it will be" -" used to define which members are public, unless the ``:ignore-module-all:``" -" option is set." +" used to define which members are public, unless the :rst:dir:`:ignore-" +"module-all: ` option is set." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:372 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:615 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:376 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:620 msgid "" "To only document certain members, an explicit comma-separated list may be " "used as the argument to ``:members:``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:383 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:626 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:387 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:631 msgid "Exclude the given names from the members to document. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:397 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:401 msgid "" "To prevent documentation of imported classes or functions, in an " ":rst:dir:`!automodule` directive with the ``members`` option set, only " @@ -379,91 +379,90 @@ msgid "" "name given to ``automodule`` will be documented." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:402 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:406 msgid "" "Set the ``imported-members`` option if you want to prevent this behavior and" " document all available members." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:405 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:409 msgid "" "Note that attributes from imported modules will not be documented, because " "attribute documentation is discovered by parsing the source file of the " "current module." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:414 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:418 msgid "" "Generate automatic documentation for members of the target module that don't" " have a docstring or doc-comment. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:427 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:431 msgid "" "Generate automatic documentation for private members of the target module. " "This includes names with a leading underscore (e.g. ``_private``) and those " "members explicitly marked as private with ``:meta private:``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:437 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:703 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:441 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:708 msgid "" "To only document certain private members, an explicit comma-separated list " "may be used as the argument to ``:private-members:``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:447 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:475 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:741 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:451 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:479 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:746 msgid "The option can now take a comma-separated list of arguments." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:453 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:457 msgid "" "Generate automatic documentation for special members of the target module, " -"also known as :ref:`\"dunder\" names `. This includes " -"all names enclosed with a double-underscore, e.g. ``__special__``:" +"also known as :ref:`'dunder' names `. This includes all" +" names enclosed with a double-underscore, e.g. ``__special__``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:464 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:730 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:468 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:735 msgid "" "To only document certain special members, an explicit comma-separated list " "may be used as the argument to ``:special-members:``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:479 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:745 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:483 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:750 msgid "Options for documented members" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:483 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:749 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:487 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:754 msgid "" "Choose the ordering of automatically documented members (default: " "``alphabetical``). This overrides the :confval:`autodoc_member_order` " "setting." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:487 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:491 msgid "``alphabetical``: Use simple alphabetical order." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:489 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:493 msgid "" "``groupwise``: Group by object type (class, function, etc), use alphabetical" " order within groups." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:492 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:496 msgid "" "``bysource``: Use the order of objects in the module's source. The " "``__all__`` variable can be used to override this order." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:496 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:762 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:980 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:500 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:767 msgid "" "Note that for source order, the module must be a Python module with the " "source code available." @@ -471,109 +470,109 @@ msgstr "" "Observe que, para a ordem de origem, o módulo deve ser um módulo Python com " "o código-fonte disponível." -#: ../../sphinx/doc/usage/extensions/autodoc.rst:500 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:766 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:504 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:771 msgid "Support the ``'bysource'`` option." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:506 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:510 msgid "" -"Enable the ``:show-inheritance:`` option for all members of the module, if " -"``:members:`` is enabled." +"Enable the :rst:dir:`:show-inheritance: ` option" +" for all members of the module, if ``:members:`` is enabled." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:513 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:518 msgid "Automatically document classes or exceptions" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:518 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:523 msgid "" -"Document a class. For exception classes, prefer ``autoexception``. By " +"Document a class. For exception classes, prefer ``.. autoexception::``. By " "default, the directive only inserts the docstring of the class itself:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:551 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:828 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:556 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:833 msgid "Advanced usage" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:552 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:829 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:557 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:834 msgid "" "It is possible to override the signature for explicitly documented callable " "objects (functions, methods, classes) with the regular syntax that will " "override the signature gained from introspection:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:562 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:839 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:567 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:844 msgid "" "This is useful if the signature from the method is hidden by a decorator." msgstr "" "Isso é útil se a assinatura do método estiver oculta por um decorador." -#: ../../sphinx/doc/usage/extensions/autodoc.rst:571 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:898 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:576 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:903 msgid "" "Do not generate an index entry for the documented class or any auto-" "documented members." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:579 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:584 msgid "" "Select which docstring will be used for the main body of the directive. This" " overrides the global value of :confval:`autoclass_content`. The possible " "values are:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:583 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:588 msgid "" "``class``: Only use the class's docstring. The :meth:`!__init__` method can " "be separately documented using the ``:members:`` option or " ":rst:dir:`automethod`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:587 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:592 msgid "``init``: Only use the docstring of the :meth:`!__init__` method." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:589 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:594 msgid "" -"``both`` Use both, appending the docstring of the :meth:`!__init__` method " +"``both``: Use both, appending the docstring of the :meth:`!__init__` method " "to the class's docstring." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:593 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:598 msgid "" "If the :meth:`!__init__` method doesn't exist or has a blank docstring, " "``autodoc`` will attempt to use the :meth:`!__new__` method's docstring, if " "it exists and is not blank." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:604 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:609 msgid "Generate automatic documentation for all members of the target class:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:611 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:616 msgid "" "By default, ``autodoc`` only includes public members with a docstring or " ":ref:`doc-comment ` (``#:``) that are attributes of the target " "class (i.e. not inherited)." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:640 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:645 msgid "" "To generate automatic documentation for members inherited from base classes," " use the ``:inherited-members:`` option:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:649 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:654 msgid "" "This can be combined with the ``:undoc-members:`` option to generate " "automatic documentation for *all* available members of the class." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:652 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:657 msgid "" "The members of classes listed in the argument to ``:inherited-members:`` are" " excluded from the automatic documentation. This defaults to " @@ -582,105 +581,105 @@ msgid "" "as the argument." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:658 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:663 msgid "" "For example; If your class ``MyList`` is derived from ``list`` class and you" " don't want to document ``list.__len__()``, you should specify a option " "``:inherited-members: list`` to avoid special members of list class." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:664 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:669 msgid "" "Should any of the inherited members use a format other than reStructuredText" " for their docstrings, there may be markup warnings or errors." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:670 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:675 msgid "" "``:inherited-members:`` now takes the name of a base class to exclude as an " "argument." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:674 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:679 msgid "A comma separated list of base class names can be used." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:680 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:685 msgid "" "Generate automatic documentation for members of the target class that don't " "have a docstring or doc-comment. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:693 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:698 msgid "" "Generate automatic documentation for private members of the target class. " "This includes names with a leading underscore (e.g. ``_private``) and those " "members explicitly marked as private with ``:meta private:``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:713 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:718 msgid "The option can now take arguments." msgstr "A opção agora pode receber argumentos." -#: ../../sphinx/doc/usage/extensions/autodoc.rst:719 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:724 msgid "" "Generate automatic documentation for special members of the target class, " -"also known as :ref:`\"dunder\" names `. This includes " -"all names enclosed with a double-underscore, e.g. ``__special__``:" +"also known as :ref:`'dunder' names `. This includes all" +" names enclosed with a double-underscore, e.g. ``__special__``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:753 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:758 msgid "``'alphabetical'``: Use simple alphabetical order." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:755 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:760 msgid "" "``'groupwise'``: Group by object type (class, function, etc), use " "alphabetical order within groups." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:758 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:763 msgid "" "``'bysource'``: Use the order of objects in the module's source. The " "``__all__`` variable can be used to override this order." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:772 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:777 msgid "Insert the class's base classes after the class signature." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:778 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:783 msgid "Automatically document function-like objects" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:785 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:790 msgid "" "Document a function, method, property, or decorator. By default, the " "directive only inserts the docstring of the function itself:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:800 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:874 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:805 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:879 msgid "" "The directive can also contain content of its own, which will be inserted " "into the resulting non-auto directive source after the docstring." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:804 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:809 msgid "" "Therefore, you can also mix automatic and non-automatic documentation, as " "follows:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:813 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:818 msgid ":rst:dir:`autodecorator`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:815 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:820 msgid ":rst:dir:`autoproperty`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:820 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:825 msgid "" "If you document decorated functions or methods, keep in mind that " "``autodoc`` retrieves its docstrings by importing the module and inspecting " @@ -689,32 +688,32 @@ msgid "" "the original ``__doc__`` to the new function." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:848 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:853 msgid "Do not generate an index entry for the documented function." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:854 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:859 msgid "Automatically document attributes or data" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:859 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:864 msgid "" "Document a module level variable or constant ('data') or class attribute. By" " default, the directive only inserts the docstring of the variable itself:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:887 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:892 msgid "" ":rst:dir:`autodata` and :rst:dir:`autoattribute` can now extract docstrings." msgstr "" ":rst:dir:`autodata` e :rst:dir:`autoattribute` agora podem extrair " "docstrings." -#: ../../sphinx/doc/usage/extensions/autodoc.rst:890 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:895 msgid "Doc-comments are now allowed on the same line of an assignment." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:908 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:913 msgid "" "By default, ``autodoc`` attempts to obtain the type annotation and value of " "the variable by introspection, displaying it after the variable's name. To " @@ -722,35 +721,43 @@ msgid "" "argument to ``annotation``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:914 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:919 msgid "" "For example, if the runtime value of ``FILE_MODE`` is ``0o755``, the " "displayed value will be ``493`` (as ``oct(493) == '0o755'``). This can be " "fixed by setting ``:annotation: = 0o755``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:918 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:923 msgid "" -"If ``annotation`` is used without arguments, no value or type hint will be " -"shown for the variable." +"If ``:annotation:`` is used without arguments, no value or type hint will be" +" shown for the variable." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:925 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:930 msgid "" -"To display the type hint of the variable without a value, use the ``no-" -"value`` option. If both the ``annotation`` and ``no-value`` options are " -"used, ``no-value`` has no effect." +"To display the type hint of the variable without a value, use the ``:no-" +"value:`` option. If both the ``:annotation:`` and ``:no-value:`` options are" +" used, ``:no-value:`` has no effect." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:932 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:937 msgid "Configuration" msgstr "Configuração" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:934 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:939 msgid "There are also config values that you can set:" msgstr "Existem também valores de configuração que você pode definir:" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:938 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:0 +msgid "Type" +msgstr "Type" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:0 +msgid "Default" +msgstr "Default" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:945 msgid "" "This value selects what content will be inserted into the main body of an " ":rst:dir:`autoclass` directive. The possible values are:" @@ -758,25 +765,22 @@ msgstr "" "Este valor seleciona qual conteúdo será inserido no corpo principal de uma " "diretiva :rst:dir:`autoclass`. Os valores possíveis são:" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:941 -msgid "``\"class\"``" -msgstr "``\"class\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:948 +msgid "``'class'``" +msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:942 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:949 msgid "" -"Only the class' docstring is inserted. This is the default. You can still " -"document ``__init__`` as a separate method using :rst:dir:`automethod` or " -"the ``members`` option to :rst:dir:`autoclass`." +"Only the class' docstring is inserted. You can still document ``__init__`` " +"as a separate method using :rst:dir:`automethod` or the ``members`` option " +"to :rst:dir:`autoclass`." msgstr "" -"Apenas a docstring da classe é inserida. Este é o padrão. Você ainda pode " -"documentar ``__init__`` como um método separado usando :rst:dir:`automethod`" -" ou a opção ``members`` para :rst:dir:`autoclass`." -#: ../../sphinx/doc/usage/extensions/autodoc.rst:945 -msgid "``\"both\"``" -msgstr "``\"both\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:952 +msgid "``'both'``" +msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:946 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:953 msgid "" "Both the class' and the ``__init__`` method's docstring are concatenated and" " inserted." @@ -784,15 +788,15 @@ msgstr "" "As docstrings da classe e do método ``__init__`` são concatenadas e " "inseridas." -#: ../../sphinx/doc/usage/extensions/autodoc.rst:948 -msgid "``\"init\"``" -msgstr "``\"init\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:955 +msgid "``'init'``" +msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:949 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:956 msgid "Only the ``__init__`` method's docstring is inserted." msgstr "Somente a docstring do método ``__init__`` é inserida." -#: ../../sphinx/doc/usage/extensions/autodoc.rst:953 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:960 msgid "" "If the class has no ``__init__`` method or if the ``__init__`` method's " "docstring is empty, but the class has a ``__new__`` method's docstring, it " @@ -802,7 +806,7 @@ msgstr "" "``__init__`` estiver vazia, mas a classe tem a docstring do método " "``__new__``, ela é usada no lugar." -#: ../../sphinx/doc/usage/extensions/autodoc.rst:961 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:970 msgid "" "This value selects how the signature will be displayed for the class defined" " by :rst:dir:`autoclass` directive. The possible values are:" @@ -810,68 +814,67 @@ msgstr "" "Este valor seleciona como a assinatura será exibida para a classe definida " "pela diretiva :rst:dir:`autoclass`. Os valores possíveis são:" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:964 -msgid "``\"mixed\"``" -msgstr "``\"mixed\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:973 +msgid "``'mixed'``" +msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:965 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:974 msgid "Display the signature with the class name." msgstr "Exibe a assinatura com o nome da classe." -#: ../../sphinx/doc/usage/extensions/autodoc.rst:966 -msgid "``\"separated\"``" -msgstr "``\"separated\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:975 +msgid "``'separated'``" +msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:967 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:976 msgid "Display the signature as a method." msgstr "Exibe a assinatura como um método." -#: ../../sphinx/doc/usage/extensions/autodoc.rst:969 -msgid "The default is ``\"mixed\"``." -msgstr "O padrão é ``\"mixed\"``." - -#: ../../sphinx/doc/usage/extensions/autodoc.rst:975 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:984 msgid "" -"This value selects if automatically documented members are sorted " -"alphabetical (value ``'alphabetical'``), by member type (value " -"``'groupwise'``) or by source order (value ``'bysource'``). The default is " -"alphabetical." +"Define the order in which :rst:dir:`automodule` and :rst:dir:`autoclass` " +"members are listed. Supported values are:" msgstr "" -"Esse valor seleciona se os membros documentados automaticamente são " -"classificados em ordem alfabética (valor ``'alphabetical'``), por tipo de " -"membro (valor ``'groupwise'``) ou por ordem de origem (valor " -"``'bysource'``). O padrão é alfabético." -#: ../../sphinx/doc/usage/extensions/autodoc.rst:984 -msgid "Support for ``'bysource'``." -msgstr "Suporte para ``'bysource'``." +#: ../../sphinx/doc/usage/extensions/autodoc.rst:987 +msgid "``'alphabetical'``: Use alphabetical order." +msgstr "" #: ../../sphinx/doc/usage/extensions/autodoc.rst:989 +msgid "``'groupwise'``: order by member type. The order is:" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:991 +msgid "for modules, exceptions, classes, functions, data" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:992 +msgid "for classes: methods, then properties and attributes" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:994 +msgid "Members are ordered alphabetically within groups." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:996 msgid "" -"This value is a list of autodoc directive flags that should be automatically" -" applied to all autodoc directives. The supported flags are ``'members'``, " -"``'undoc-members'``, ``'private-members'``, ``'special-members'``, " -"``'inherited-members'``, ``'show-inheritance'``, ``'ignore-module-all'`` and" -" ``'exclude-members'``." +"``'bysource'``: Use the order in which the members appear in the source " +"code. This requires that the module must be a Python module with the source " +"code available." msgstr "" -"Esse valor é uma lista de sinalizadores de diretivas do autodoc que devem " -"ser aplicados automaticamente a todas as diretivas do autodoc. Os " -"sinalizadores suportados são ``'members'``, ``'undoc-members'``, ``'private-" -"members'``, ``'special-members'``, ``'inherited-members'``, ``'show-" -"inheritance'``, ``'ignore-module-all'`` e ``'exclude-members'``." -#: ../../sphinx/doc/usage/extensions/autodoc.rst:999 -msgid "Integrated into :confval:`autodoc_default_options`." -msgstr "Integrado em :confval:`autodoc_default_options`." +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1002 +msgid "Support for ``'bysource'``." +msgstr "Suporte para ``'bysource'``." -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1003 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1009 msgid "" "The default options for autodoc directives. They are applied to all autodoc" " directives automatically. It must be a dictionary which maps option names " "to the values. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1017 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1023 msgid "" "Setting ``None`` or ``True`` to the value is equivalent to giving only the " "option name to the directives." @@ -879,35 +882,75 @@ msgstr "" "Definir ``None`` ou ``True`` como o valor é equivalente a fornecer apenas o " "nome da opção às diretivas." -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1020 -msgid "" -"The supported options are ``'members'``, ``'member-order'``, ``'undoc-" -"members'``, ``'private-members'``, ``'special-members'``, ``'inherited-" -"members'``, ``'show-inheritance'``, ``'ignore-module-all'``, ``'imported-" -"members'``, ``'exclude-members'``, ``'class-doc-from'`` and ``'no-value'``." +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1026 +msgid "The supported options are:" msgstr "" -"As opções válidas são ``'members'``, ``'member-order'``, ``'undoc-" -"members'``, ``'private-members'``, ``'special-members'``, ``'inherited-" -"members'``, ``'show-inheritance'``, ``'ignore-module-all'``, ``'imported-" -"members'``, ``'exclude-members'``, ``'class-doc-from'`` e ``'no-value'``." #: ../../sphinx/doc/usage/extensions/autodoc.rst:1028 +msgid "``'members'``: See :rst:dir:`automodule:members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1029 +msgid "``'undoc-members'`` See :rst:dir:`automodule:undoc-members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1030 +msgid "``'private-members'``: See :rst:dir:`automodule:private-members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1031 +msgid "``'special-members'``: See :rst:dir:`automodule:special-members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1032 +msgid "``'inherited-members'``: See :rst:dir:`autoclass:inherited-members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1033 +msgid "``'imported-members'``: See :rst:dir:`automodule:imported-members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1034 +msgid "``'exclude-members'``: See :rst:dir:`automodule:exclude-members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1035 +msgid "``'ignore-module-all'``: See :rst:dir:`automodule:ignore-module-all`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1036 +msgid "``'member-order'``: See :rst:dir:`automodule:member-order`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1037 +msgid "``'show-inheritance'``: See :rst:dir:`autoclass:show-inheritance`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1038 +msgid "``'class-doc-from'``: See :rst:dir:`autoclass:class-doc-from`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1039 +msgid "``'no-value'``: See :rst:dir:`autodata:no-value`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1043 msgid "Accepts ``True`` as a value." msgstr "Aceita ``True`` como valor." -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1031 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1046 msgid "Added ``'imported-members'``." msgstr "Adicionado ``'imported-members'``." -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1034 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1049 msgid "Added ``'class-doc-from'``." msgstr "Adicionado ``'class-doc-from'``." -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1037 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1052 msgid "Added ``'no-value'``." msgstr "Adicionado ``'no-value'``." -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1042 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1059 msgid "" "Functions imported from C modules cannot be introspected, and therefore the " "signature for such functions cannot be automatically determined. However, " @@ -919,7 +962,7 @@ msgstr "" "automaticamente. No entanto, é uma convenção frequentemente usada para " "colocar a assinatura na primeira linha da docstring da função." -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1047 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1064 msgid "" "If this boolean value is set to ``True`` (which is the default), autodoc " "will look at the first line of the docstring for functions and methods, and " @@ -931,7 +974,7 @@ msgstr "" "parecer com uma assinatura, use a linha como assinatura e remova-a do " "conteúdo da docstring." -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1052 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1069 msgid "" "autodoc will continue to look for multiple signature lines, stopping at the " "first line that does not look like a signature. This is useful for declaring" @@ -941,17 +984,17 @@ msgstr "" "primeira linha que não se parece com uma assinatura. Isso é útil para " "declarar assinaturas de função sobrecarregadas." -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1059 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1076 msgid "Support overloaded signatures" msgstr "Suporte a assinaturas sobrecarregadas" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1063 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1080 msgid "Overloaded signatures do not need to be separated by a backslash" msgstr "" "Assinaturas sobrecarregadas não precisam ser separadas por uma barra " "invertida" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1067 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1086 msgid "" "This value contains a list of modules to be mocked up. This is useful when " "some external dependencies are not met at build time and break the building " @@ -963,11 +1006,11 @@ msgstr "" " e interrompem o processo de construção. Você só pode especificar o pacote " "raiz das próprias dependências e omitir os submódulos:" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1076 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1095 msgid "Will mock all imports under the ``django`` package." msgstr "Fará um mock de todas as importações sob o pacote ``django``." -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1080 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1099 msgid "" "This config value only requires to declare the top-level modules that should" " be mocked." @@ -975,7 +1018,7 @@ msgstr "" "Esse valor de configuração requer apenas para declarar os módulos de nível " "superior que devem ser mockados." -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1086 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1107 msgid "" "This value controls how to represent typehints. The setting takes the " "following values:" @@ -983,11 +1026,11 @@ msgstr "" "Este valor controla como representar dicas de tipo. A configuração presume " "os seguintes valores:" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1089 -msgid "``'signature'`` -- Show typehints in the signature (default)" -msgstr "``'signature'`` -- Mostra dicas de tipo na assinatura (padrão)" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1110 +msgid "``'signature'`` -- Show typehints in the signature" +msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1090 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1111 msgid "" "``'description'`` -- Show typehints as content of the function or method The" " typehints of overloaded functions or methods will still be represented in " @@ -997,11 +1040,11 @@ msgstr "" "As dicas de tipo de funções ou métodos sobrecarregados ainda serão " "representadas na assinatura." -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1093 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1114 msgid "``'none'`` -- Do not show typehints" msgstr "``'none'`` -- Não mostra dicas de tipo" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1094 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1115 msgid "" "``'both'`` -- Show typehints in the signature and as content of the function" " or method" @@ -1009,7 +1052,7 @@ msgstr "" "``'both'`` -- Mostra dicas de tipo na assinatura e como conteúdo da função " "ou método" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1097 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1118 msgid "" "Overloaded functions or methods will not have typehints included in the " "description because it is impossible to accurately represent all possible " @@ -1019,66 +1062,52 @@ msgstr "" "descrição porque é impossível representar com precisão todas as sobrecargas " "possíveis como uma lista de parâmetros." -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1104 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1125 msgid "New option ``'description'`` is added." msgstr "A nova opção ``'description'`` foi adicionada." -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1108 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1129 msgid "New option ``'both'`` is added." msgstr "A nova opção ``'both'`` foi adicionada." -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1112 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1135 msgid "" "This value controls whether the types of undocumented parameters and return " -"values are documented when ``autodoc_typehints`` is set to ``description``." +"values are documented when :confval:`autodoc_typehints` is set to " +"``'description'``. Supported values:" msgstr "" -"Este valor controla se os tipos de parâmetros não documentados e valores de " -"retorno são documentados quando ``autodoc_typehints`` é definido como " -"``description``." -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1115 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1140 msgid "" -"The default value is ``\"all\"``, meaning that types are documented for all " -"parameters and return values, whether they are documented or not." +"``'all'``: Types are documented for all parameters and return values, " +"whether they are documented or not." msgstr "" -"O valor padrão é ``\"all\"``, o que significa que os tipos são documentados " -"para todos os parâmetros e valores de retorno, sejam eles documentados ou " -"não." -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1118 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1143 msgid "" -"When set to ``\"documented\"``, types will only be documented for a " -"parameter or a return value that is already documented by the docstring." +"``'documented'``: Types will only be documented for a parameter or a return " +"value that is already documented by the docstring." msgstr "" -"Quando definido como ``\"documented\"``, os tipos só serão documentados para" -" um parâmetro ou valor de retorno que já está documentado pela docstring." -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1121 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1146 msgid "" -"With ``\"documented_params\"``, parameter types will only be annotated if " -"the parameter is documented in the docstring. The return type is always " +"``'documented_params'``: Parameter types will only be annotated if the " +"parameter is documented in the docstring. The return type is always " "annotated (except if it is ``None``)." msgstr "" -"Com ``\"documented_params\"``, os tipos de parâmetro só serão anotados se o " -"parâmetro estiver documentado na docstring. O tipo de retorno é sempre " -"anotado (exceto se for ``None``)." -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1129 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1155 msgid "New option ``'documented_params'`` is added." msgstr "Nova opção ``'documented_params'`` foi adicionada." -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1133 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1161 msgid "" "A dictionary for users defined `type aliases`__ that maps a type name to the" " full-qualified object name. It is used to keep type aliases not evaluated " -"in the document. Defaults to empty (``{}``)." +"in the document." msgstr "" -"Um dicionário para `apelidos de tipo`__ definidos pelos usuários que mapeia " -"um nome de tipo para o nome de objeto totalmente qualificado. É usado para " -"manter os apelidos de tipo não avaliados no documento. O padrão é vazio " -"(``{}``)." -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1137 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1165 msgid "" "The type aliases are only available if your program enables :pep:`Postponed " "Evaluation of Annotations (PEP 563) <563>` feature via ``from __future__ " @@ -1088,23 +1117,23 @@ msgstr "" "recurso :pep:`Avaliação Adiada de Anotações (PEP 563) <563>` via ``from " "__future__ import annotations``." -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1141 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1169 msgid "For example, there is code using a type alias:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1152 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1180 msgid "" "If ``autodoc_type_aliases`` is not set, autodoc will generate internal mark-" "up from this code as following:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1161 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1189 msgid "" "If you set ``autodoc_type_aliases`` as ``{'AliasType': " "'your.module.AliasType'}``, it generates the following document internally:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1176 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1206 msgid "" "This value controls the format of typehints. The setting takes the " "following values:" @@ -1112,25 +1141,23 @@ msgstr "" "Este valor controla o formato das dicas de tipo. A configuração assume os " "seguintes valores:" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1179 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1209 msgid "" "``'fully-qualified'`` -- Show the module name and its name of typehints" msgstr "" "``'fully-qualified'`` -- Mostra o nome do módulo e seu nome de dicas de tipo" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1180 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1210 msgid "" "``'short'`` -- Suppress the leading module names of the typehints (e.g. " -"``io.StringIO`` -> ``StringIO``) (default)" +"``io.StringIO`` -> ``StringIO``)" msgstr "" -"``'short'`` -- Suprime os nomes dos módulos principais das dicas de tipo " -"(por exemplo, ``io.StringIO`` -> ``StringIO``) (padrão)" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1187 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1217 msgid "The default setting was changed to ``'short'``" msgstr "A configuração padrão foi alterada para ``'short'``" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1191 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1223 msgid "" "If True, the default argument values of functions will be not evaluated on " "generating document. It preserves them as is in the source code." @@ -1138,7 +1165,7 @@ msgstr "" "Se for True, os valores de argumento padrão das funções não serão avaliados " "na geração do documento. Ele os preserva como estão no código-fonte." -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1196 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1228 msgid "" "Added as an experimental feature. This will be integrated into autodoc core" " in the future." @@ -1146,19 +1173,14 @@ msgstr "" "Adicionado como um recurso experimental. Isso será integrado ao autodoc core" " no futuro." -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1201 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1235 msgid "" "This value controls the behavior of :option:`sphinx-build --fail-on-warning`" " during importing modules. If ``False`` is given, autodoc forcedly " -"suppresses the error if the imported module emits warnings. By default, " -"``True``." +"suppresses the error if the imported module emits warnings." msgstr "" -"Este valor controla o comportamento de :option:`sphinx-build --fail-on-" -"warning` durante a importação de módulos. Se ``False`` for fornecido, o " -"autodoc suprime o erro à força se o módulo importado emitir avisos. Por " -"padrão, ``True``." -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1206 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1240 msgid "" "This option now has no effect as :option:`!--fail-on-warning` no longer " "exits early." @@ -1166,7 +1188,7 @@ msgstr "" "Esta opção agora não tem efeito, pois :option:`!--fail-on-warning` não mais " "encerra cedo." -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1212 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1248 msgid "" "This value controls the docstrings inheritance. If set to True the docstring" " for classes or methods, if not explicitly set, is inherited from parents." @@ -1175,37 +1197,30 @@ msgstr "" "docstring para classes ou métodos, se não for definida explicitamente, é " "herdada dos pais." -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1216 -msgid "The default is ``True``." -msgstr "O padrão é ``True``." - -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1223 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1259 msgid "" -":mod:`autodoc` supports to suppress warning messages via " -":confval:`suppress_warnings`. It allows following warnings types in " -"addition:" +":mod:`autodoc` supports suppressing warning messages via " +":confval:`suppress_warnings`. It defines the following additional warnings " +"types:" msgstr "" -":mod:`autodoc` oferece suporte à supressão de mensagens de aviso através de " -":confval:`suppress_warnings`. Ele permite seguir os seguintes tipos de " -"avisos:" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1227 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1263 msgid "autodoc" msgstr "autodoc" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1228 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1264 msgid "autodoc.import_object" msgstr "autodoc.import_object" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1232 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1268 msgid "Docstring preprocessing" msgstr "Pré-processamento de docstrings" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1234 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1270 msgid "autodoc provides the following additional events:" msgstr "autodoc fornece os seguintes eventos adicionais:" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1240 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1276 msgid "" "Emitted when autodoc has read and processed a docstring. *lines* is a list " "of strings -- the lines of the processed docstring -- that the event handler" @@ -1220,44 +1235,40 @@ msgstr "" msgid "Parameters" msgstr "Parâmetros" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1244 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1263 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1275 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1304 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1336 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1280 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1299 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1311 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1340 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1372 msgid "the Sphinx application object" msgstr "o objeto do aplicativo Sphinx" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1245 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1276 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1337 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1281 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1312 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1373 msgid "" -"the type of the object which the docstring belongs to (one of " -"``\"module\"``, ``\"class\"``, ``\"exception\"``, ``\"function\"``, " -"``\"method\"``, ``\"attribute\"``)" +"the type of the object which the docstring belongs to (one of ``'module'``, " +"``'class'``, ``'exception'``, ``'function'``, ``'method'``, ``'attribute'``)" msgstr "" -"o tipo do objeto ao qual a docstring pertence (um dos ``\"module\"``, " -"``\"class\"``, ``\"exception\"``, ``\"function\"``, ``\"method\"``, " -"``\"attribute\"``)" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1248 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1279 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1305 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1340 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1284 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1315 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1341 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1376 msgid "the fully qualified name of the object" msgstr "o nome totalmente qualificado do objeto" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1249 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1264 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1280 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1306 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1341 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1285 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1300 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1316 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1342 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1377 msgid "the object itself" msgstr "o objeto em si" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1250 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1281 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1344 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1286 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1317 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1380 msgid "" "the options given to the directive: an object with attributes " "``inherited_members``, ``undoc_members``, ``show_inheritance`` and ``no-" @@ -1269,11 +1280,11 @@ msgstr "" "index`` que são verdadeiros se a opção de sinalizador com o mesmo nome foi " "dada à diretiva auto" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1254 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1290 msgid "the lines of the docstring, see above" msgstr "as linhas da docstring, veja acima" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1260 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1296 msgid "" "Emitted before autodoc formats a signature for an object. The event handler " "can modify an object to change its signature." @@ -1281,11 +1292,11 @@ msgstr "" "Emitido antes do autodoc formatar uma assinatura para um objeto. O " "manipulador de eventos pode modificar um objeto para alterar sua assinatura." -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1265 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1301 msgid "a boolean indicates an object is bound method or not" msgstr "um booleano indica que um objeto é um método vinculado ou não" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1271 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1307 msgid "" "Emitted when autodoc has formatted a signature for an object. The event " "handler can return a new tuple ``(signature, return_annotation)`` to change " @@ -1295,25 +1306,20 @@ msgstr "" "manipulador de eventos pode retornar uma nova tupla ``(signature, " "return_annotation)`` para alterar o que o Sphinx coloca na saída." -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1285 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1321 msgid "" -"function signature, as a string of the form ``\"(parameter_1, " -"parameter_2)\"``, or ``None`` if introspection didn't succeed and signature " +"function signature, as a string of the form ``'(parameter_1, " +"parameter_2)'``, or ``None`` if introspection didn't succeed and signature " "wasn't specified in the directive." msgstr "" -"assinatura de função, como uma string no formato ``\"(parameter_1, " -"parameter_2)\"`` ou ``None`` se a introspecção não tiver sido bem-sucedida e" -" a assinatura não tiver sido especificada na diretiva." -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1288 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1324 msgid "" -"function return annotation as a string of the form ``\" -> annotation\"``, " -"or ``None`` if there is no return annotation" +"function return annotation as a string of the form ``' -> annotation'``, or " +"``None`` if there is no return annotation" msgstr "" -"anotação do retorno da função como uma string no formato ``\" -> " -"annotation\"``, ou ``None`` se não houver anotação de retorno" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1291 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1327 msgid "" "The :mod:`sphinx.ext.autodoc` module provides factory functions for commonly" " needed docstring processing in event :event:`autodoc-process-docstring`:" @@ -1367,7 +1373,7 @@ msgstr "" "Se *what* for uma sequência de strings, somente as docstrings de um tipo em " "*what* serão processadas." -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1299 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1335 msgid "" "Emitted when autodoc has read and processed a class to determine the base-" "classes. *bases* is a list of classes that the event handler can modify " @@ -1379,15 +1385,15 @@ msgstr "" "modificar **no local** para alterar o que o Sphinx coloca na saída. É " "emitido apenas se a opção ``show-inheritance`` for fornecida." -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1307 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1343 msgid "the options given to the class directive" msgstr "as opções fornecidas para a diretiva da classe" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1308 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1344 msgid "the list of base classes signature. see above." msgstr "a lista de assinatura de classes base, veja acima." -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1313 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1349 msgid "" "``bases`` can contain a string as a base class name. It will be processed as" " reStructuredText." @@ -1395,11 +1401,11 @@ msgstr "" "``bases`` pode conter uma string como nome de classe base. Ele será " "processado como texto com marcação reStructuredText." -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1318 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1354 msgid "Skipping members" msgstr "Ignorando membros" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1320 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1356 msgid "" "autodoc allows the user to define a custom method for determining whether a " "member should be included in the documentation by using the following event:" @@ -1408,7 +1414,7 @@ msgstr "" "determinar se um membro deve ser incluído na documentação usando o seguinte " "evento:" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1327 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1363 msgid "" "Emitted when autodoc has to decide whether a member should be included in " "the documentation. The member is excluded if a handler returns ``True``. " @@ -1418,7 +1424,7 @@ msgstr "" "documentação. O membro é excluído se um manipulador retornar ``True``. Está " "incluído se o manipulador retornar ``False``." -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1331 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1367 msgid "" "If more than one enabled extension handles the ``autodoc-skip-member`` " "event, autodoc will use the first non-``None`` value returned by a handler. " @@ -1430,7 +1436,7 @@ msgstr "" "Os manipuladores devem retornar ``None`` para retornar ao comportamento de " "salto do autodoc e de outras extensões ativadas." -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1342 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1378 msgid "" "a boolean indicating if autodoc will skip this member if the user handler " "does not override the decision" diff --git a/locale/ru/LC_MESSAGES/changes/1.8.po b/locale/ru/LC_MESSAGES/changes/1.8.po index 6020c04f26..fe849b59eb 100644 --- a/locale/ru/LC_MESSAGES/changes/1.8.po +++ b/locale/ru/LC_MESSAGES/changes/1.8.po @@ -11,7 +11,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-10-01 00:54+0000\n" +"POT-Creation-Date: 2024-10-03 00:49+0000\n" "PO-Revision-Date: 2024-07-31 00:36+0000\n" "Last-Translator: Georg Brandl , 2024\n" "Language-Team: Russian (https://app.transifex.com/sphinx-doc/teams/15434/ru/)\n" @@ -400,7 +400,7 @@ msgstr "" #: ../../sphinx/doc/changes/1.8.rst:150 msgid "" "#5421: autodoc emits deprecation warning for " -":confval:`autodoc_default_flags`" +":confval:`!autodoc_default_flags`" msgstr "" #: ../../sphinx/doc/changes/1.8.rst:151 @@ -668,7 +668,7 @@ msgid ":confval:`!source_parsers` is deprecated" msgstr "" #: ../../sphinx/doc/changes/1.8.rst:254 -msgid ":confval:`autodoc_default_flags` is deprecated" +msgid ":confval:`!autodoc_default_flags` is deprecated" msgstr "" #: ../../sphinx/doc/changes/1.8.rst:255 diff --git a/locale/ru/LC_MESSAGES/changes/index.po b/locale/ru/LC_MESSAGES/changes/index.po index 95166f76f9..aed7e5c744 100644 --- a/locale/ru/LC_MESSAGES/changes/index.po +++ b/locale/ru/LC_MESSAGES/changes/index.po @@ -11,7 +11,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-09-28 00:48+0000\n" +"POT-Creation-Date: 2024-10-03 00:49+0000\n" "PO-Revision-Date: 2024-07-31 00:36+0000\n" "Last-Translator: Georg Brandl , 2024\n" "Language-Team: Russian (https://app.transifex.com/sphinx-doc/teams/15434/ru/)\n" @@ -238,11 +238,18 @@ msgid "" ":rst:dir:`py:module` directives. Patch by Stephen Finucane." msgstr "" -#: ../../sphinx/CHANGES.rst:112 +#: ../../sphinx/CHANGES.rst:110 +msgid "" +"#12916: Restore support for custom templates named with the legacy ``_t`` " +"suffix during ``apidoc`` RST rendering (regression in 7.4.0). Patch by James" +" Addison." +msgstr "" + +#: ../../sphinx/CHANGES.rst:115 msgid "Testing" msgstr "" -#: ../../sphinx/CHANGES.rst:114 +#: ../../sphinx/CHANGES.rst:117 msgid "" "#12141: Migrate from the deprecated ``karma`` JavaScript test framework to " "the actively-maintained ``jasmine`` framework. Test coverage is unaffected." diff --git a/locale/ru/LC_MESSAGES/extdev/deprecated.po b/locale/ru/LC_MESSAGES/extdev/deprecated.po index 89db35f88a..e6f846b5c6 100644 --- a/locale/ru/LC_MESSAGES/extdev/deprecated.po +++ b/locale/ru/LC_MESSAGES/extdev/deprecated.po @@ -12,7 +12,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-09-02 00:47+0000\n" +"POT-Creation-Date: 2024-10-03 00:50+0000\n" "PO-Revision-Date: 2019-03-09 18:04+0000\n" "Last-Translator: Georg Brandl , 2021\n" "Language-Team: Russian (https://app.transifex.com/sphinx-doc/teams/15434/ru/)\n" @@ -2853,7 +2853,7 @@ msgid ":meth:`~sphinx.application.Sphinx.add_js_file`" msgstr "" #: ../../sphinx/doc/extdev/deprecated.rst:1457 -msgid ":confval:`autodoc_default_flags`" +msgid ":confval:`!autodoc_default_flags`" msgstr "" #: ../../sphinx/doc/extdev/deprecated.rst:1460 diff --git a/locale/ru/LC_MESSAGES/usage/domains/restructuredtext.po b/locale/ru/LC_MESSAGES/usage/domains/restructuredtext.po index 9d5c85ecf3..0144acdf0d 100644 --- a/locale/ru/LC_MESSAGES/usage/domains/restructuredtext.po +++ b/locale/ru/LC_MESSAGES/usage/domains/restructuredtext.po @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-09-15 00:53+0000\n" +"POT-Creation-Date: 2024-10-03 00:49+0000\n" "PO-Revision-Date: 2023-10-03 00:37+0000\n" "Language-Team: Russian (https://app.transifex.com/sphinx-doc/teams/15434/ru/)\n" "MIME-Version: 1.0\n" @@ -75,3 +75,20 @@ msgstr "" #: ../../sphinx/doc/usage/domains/restructuredtext.rst:97 msgid "These roles are provided to refer to the described objects:" msgstr "" + +#: ../../sphinx/doc/usage/domains/restructuredtext.rst:101 +msgid "Reference directives and directive options. Examples:" +msgstr "" + +#: ../../sphinx/doc/usage/domains/restructuredtext.rst:103 +msgid "Use ``:rst:dir:`my-directive``` to reference a directive." +msgstr "" + +#: ../../sphinx/doc/usage/domains/restructuredtext.rst:104 +msgid "" +"Use ``:rst:dir:`my-directive:my-option``` to reference a directive option." +msgstr "" + +#: ../../sphinx/doc/usage/domains/restructuredtext.rst:109 +msgid "Reference a role. Example: ``:rst:role:`my-role```." +msgstr "" diff --git a/locale/ru/LC_MESSAGES/usage/extensions/autodoc.po b/locale/ru/LC_MESSAGES/usage/extensions/autodoc.po index a1d397a377..9a54c33965 100644 --- a/locale/ru/LC_MESSAGES/usage/extensions/autodoc.po +++ b/locale/ru/LC_MESSAGES/usage/extensions/autodoc.po @@ -12,7 +12,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-10-02 00:49+0000\n" +"POT-Creation-Date: 2024-10-03 00:50+0000\n" "PO-Revision-Date: 2018-06-26 15:58+0000\n" "Last-Translator: SeryiMysh , 2024\n" "Language-Team: Russian (https://app.transifex.com/sphinx-doc/teams/15434/ru/)\n" @@ -26,26 +26,26 @@ msgstr "" msgid ":mod:`sphinx.ext.autodoc` -- Include documentation from docstrings" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:12 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:15 msgid "" "This extension can import the modules you are documenting, and pull in " "documentation from docstrings in a semi-automatic way." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:17 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:20 msgid "" ":mod:`~sphinx.ext.autodoc` **imports** the modules to be documented. If any " "modules have side effects on import, these will be executed by ``autodoc`` " "when :program:`sphinx-build` is run." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:21 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:24 msgid "" "If you document scripts (as opposed to library modules), make sure that the " "main routine is protected by an ``if __name__ == '__main__'`` condition." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:25 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:28 msgid "" "For this to work, the docstrings must of course be written in correct " "reStructuredText. You can then use all of the usual Sphinx markup in the " @@ -55,7 +55,7 @@ msgid "" "auto-generated-looking pure API documentation." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:33 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:36 msgid "" "If you prefer `NumPy`_ or `Google`_ style docstrings over reStructuredText, " "you can also enable the :mod:`napoleon ` extension. " @@ -63,25 +63,25 @@ msgid "" "reStructuredText before ``autodoc`` processes them." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:43 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:46 msgid "Getting started" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:47 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:50 msgid "Setup" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:49 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:52 msgid "" "Activate the plugin by adding ``'sphinx.ext.autodoc'`` to the " ":confval:`extensions` list in :file:`conf.py`:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:61 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:64 msgid "Ensuring the code can be imported" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:63 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:66 msgid "" ":mod:`~sphinx.ext.autodoc` analyses the code and docstrings by introspection" " after **importing the modules**. For importing to work, you have to make " @@ -91,11 +91,11 @@ msgid "" "fail)." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:70 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:73 msgid "There are two ways to ensure this:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:72 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:75 msgid "" "Use an environment that contains your package and Sphinx. This can e.g. be " "your local development environment (with an editable install), or an " @@ -104,14 +104,14 @@ msgid "" "that all dependencies are available." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:78 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:81 msgid "" "It is alternatively possible to patch the Sphinx run so that it can operate " "directly on the sources; e.g. if you want to be able to do a Sphinx build " "from a source checkout." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:82 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:85 msgid "" "Patch :data:`sys.path` in :file:`conf.py` to include your source path. For " "example if you have a repository structure with :file:`doc/conf.py` and your" @@ -119,17 +119,17 @@ msgid "" "your :file:`conf.py`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:94 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:97 msgid "" "To cope with missing dependencies, specify the missing modules in the " ":confval:`autodoc_mock_imports` setting." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:99 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:102 msgid "Usage" msgstr "Использование" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:101 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:104 msgid "" "You can now use the :ref:`autodoc-directives` to add formatted documentation" " for Python code elements like functions, classes, modules, etc. For " @@ -137,48 +137,48 @@ msgid "" "docstring from the source file, you'd write:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:110 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:113 msgid "" "You can also document whole classes or even modules automatically, using " "member options for the auto directives, like:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:119 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:122 msgid "" "As a hint to autodoc extension, you can put a ``::`` separator between the " "module name and the object name to let autodoc know the correct module, if " "it is ambiguous:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:129 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:132 msgid "Marking objects as public or private" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:131 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:134 msgid "" "autodoc considers a member private if its docstring contains ``:meta " "private:`` in its :ref:`info-field-lists`. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:145 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:148 msgid "" "autodoc considers a member public if its docstring contains ``:meta " "public:`` in its :ref:`info-field-lists`, even if it starts with an " "underscore. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:160 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:163 msgid "" "autodoc considers a variable member does not have any default value if its " "docstring contains ``:meta hide-value:`` in its :ref:`info-field-lists`. " "Example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:174 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:177 msgid "Doc comments and docstrings" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:176 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:179 msgid "" "Python has no built-in support for docstrings for module data members or " "class attributes. To allow documenting these, ``autodoc`` recognises a " @@ -186,7 +186,7 @@ msgid "" " 'documentation comment'." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:181 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:184 msgid "" "These comments start with a colon and an optional space character, ``'#:'`` " "or ``'#: '``. To be recognised, the comments must appear either on the same " @@ -195,28 +195,28 @@ msgid "" "definition." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:188 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:191 msgid "" "For example, all three of the following variables have valid doc-comments:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:202 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:205 msgid "" "Alternatively, ``autodoc`` can recognise a docstring on the line immediately" " following the definition." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:205 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:208 msgid "" "In the the following class definition, all attributes have documentation " "recognised by ``autodoc``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:233 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:236 msgid "Directives" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:235 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:238 msgid "" ":mod:`autodoc` provides several directives that are versions of the usual " ":rst:dir:`py:module`, :rst:dir:`py:class` and so forth. On parsing time, " @@ -225,24 +225,24 @@ msgid "" ":rst:dir:`py:module`, :rst:dir:`py:class` etc. directive." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:244 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:247 msgid "" "Just as :rst:dir:`py:class` respects the current :rst:dir:`py:module`, " ":rst:dir:`autoclass` will also do so. Likewise, :rst:dir:`automethod` will " "respect the current :rst:dir:`py:class`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:250 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:253 msgid "Default directive options" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:252 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:255 msgid "" "To make any of the options described below the default, use the " ":confval:`autodoc_default_options` dictionary in :file:`conf.py`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:255 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:258 msgid "" "If using defaults for the ``:members:``, ``:exclude-members:``, ``:private-" "members:``, or ``:special-members:`` options, setting the option on a " @@ -251,111 +251,111 @@ msgid "" "(``+``), as follows:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:269 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:272 msgid "" "If using :confval:`autodoc_default_options`, the defaults can be disabled " "per-directive with the negated form, :samp:`:no-{option}:` as an option of " "the directive For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:281 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:284 msgid "Automatically document modules" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:285 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:288 msgid "" "Document a module. By default, the directive only inserts the docstring of " "the module itself:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:292 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:526 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:792 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:866 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:295 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:531 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:797 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:871 msgid "will produce source like this:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:300 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:534 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:303 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:539 msgid "" "The directive can also contain content of its own, which will be inserted " "into the resulting non-auto directive source after the docstring (but before" " any automatic member documentation)." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:304 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:538 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:878 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:307 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:543 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:883 msgid "" "Therefore, you can also mix automatic and non-automatic member " "documentation, as follows:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:317 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:567 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:844 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:894 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:320 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:572 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:849 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:899 msgid "Options" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:321 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:324 msgid "" "Do not generate an index entry for the documented module or any auto-" "documented members." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:329 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:332 msgid "" "Indicate platforms on which the module is available. This is identical to " ":rst:dir:`py:module`'s ``:platform:`` option." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:335 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:338 msgid "" "A sentence describing the module's purpose. This is identical to " ":rst:dir:`py:module`'s ``:synopsis:`` option." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:343 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:346 msgid "" "Mark a module as deprecated. This is identical to :rst:dir:`py:module`'s " "``:deprecated:`` option." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:351 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:354 msgid "Do not use ``__all__`` when analysing the module to document." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:356 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:600 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:359 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:605 msgid "Options for selecting members to document" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:360 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:363 msgid "Generate automatic documentation for all members of the target module:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:367 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:370 msgid "" "By default, ``autodoc`` only includes public members with a docstring or " ":ref:`doc-comment ` (``#:``). If ``__all__`` exists, it will be" -" used to define which members are public, unless the ``:ignore-module-all:``" -" option is set." +" used to define which members are public, unless the :rst:dir:`:ignore-" +"module-all: ` option is set." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:372 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:615 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:376 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:620 msgid "" "To only document certain members, an explicit comma-separated list may be " "used as the argument to ``:members:``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:383 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:626 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:387 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:631 msgid "Exclude the given names from the members to document. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:397 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:401 msgid "" "To prevent documentation of imported classes or functions, in an " ":rst:dir:`!automodule` directive with the ``members`` option set, only " @@ -363,198 +363,197 @@ msgid "" "name given to ``automodule`` will be documented." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:402 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:406 msgid "" "Set the ``imported-members`` option if you want to prevent this behavior and" " document all available members." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:405 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:409 msgid "" "Note that attributes from imported modules will not be documented, because " "attribute documentation is discovered by parsing the source file of the " "current module." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:414 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:418 msgid "" "Generate automatic documentation for members of the target module that don't" " have a docstring or doc-comment. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:427 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:431 msgid "" "Generate automatic documentation for private members of the target module. " "This includes names with a leading underscore (e.g. ``_private``) and those " "members explicitly marked as private with ``:meta private:``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:437 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:703 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:441 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:708 msgid "" "To only document certain private members, an explicit comma-separated list " "may be used as the argument to ``:private-members:``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:447 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:475 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:741 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:451 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:479 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:746 msgid "The option can now take a comma-separated list of arguments." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:453 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:457 msgid "" "Generate automatic documentation for special members of the target module, " -"also known as :ref:`\"dunder\" names `. This includes " -"all names enclosed with a double-underscore, e.g. ``__special__``:" +"also known as :ref:`'dunder' names `. This includes all" +" names enclosed with a double-underscore, e.g. ``__special__``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:464 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:730 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:468 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:735 msgid "" "To only document certain special members, an explicit comma-separated list " "may be used as the argument to ``:special-members:``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:479 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:745 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:483 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:750 msgid "Options for documented members" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:483 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:749 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:487 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:754 msgid "" "Choose the ordering of automatically documented members (default: " "``alphabetical``). This overrides the :confval:`autodoc_member_order` " "setting." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:487 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:491 msgid "``alphabetical``: Use simple alphabetical order." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:489 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:493 msgid "" "``groupwise``: Group by object type (class, function, etc), use alphabetical" " order within groups." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:492 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:496 msgid "" "``bysource``: Use the order of objects in the module's source. The " "``__all__`` variable can be used to override this order." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:496 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:762 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:980 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:500 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:767 msgid "" "Note that for source order, the module must be a Python module with the " "source code available." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:500 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:766 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:504 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:771 msgid "Support the ``'bysource'`` option." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:506 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:510 msgid "" -"Enable the ``:show-inheritance:`` option for all members of the module, if " -"``:members:`` is enabled." +"Enable the :rst:dir:`:show-inheritance: ` option" +" for all members of the module, if ``:members:`` is enabled." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:513 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:518 msgid "Automatically document classes or exceptions" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:518 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:523 msgid "" -"Document a class. For exception classes, prefer ``autoexception``. By " +"Document a class. For exception classes, prefer ``.. autoexception::``. By " "default, the directive only inserts the docstring of the class itself:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:551 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:828 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:556 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:833 msgid "Advanced usage" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:552 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:829 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:557 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:834 msgid "" "It is possible to override the signature for explicitly documented callable " "objects (functions, methods, classes) with the regular syntax that will " "override the signature gained from introspection:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:562 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:839 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:567 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:844 msgid "" "This is useful if the signature from the method is hidden by a decorator." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:571 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:898 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:576 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:903 msgid "" "Do not generate an index entry for the documented class or any auto-" "documented members." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:579 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:584 msgid "" "Select which docstring will be used for the main body of the directive. This" " overrides the global value of :confval:`autoclass_content`. The possible " "values are:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:583 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:588 msgid "" "``class``: Only use the class's docstring. The :meth:`!__init__` method can " "be separately documented using the ``:members:`` option or " ":rst:dir:`automethod`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:587 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:592 msgid "``init``: Only use the docstring of the :meth:`!__init__` method." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:589 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:594 msgid "" -"``both`` Use both, appending the docstring of the :meth:`!__init__` method " +"``both``: Use both, appending the docstring of the :meth:`!__init__` method " "to the class's docstring." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:593 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:598 msgid "" "If the :meth:`!__init__` method doesn't exist or has a blank docstring, " "``autodoc`` will attempt to use the :meth:`!__new__` method's docstring, if " "it exists and is not blank." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:604 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:609 msgid "Generate automatic documentation for all members of the target class:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:611 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:616 msgid "" "By default, ``autodoc`` only includes public members with a docstring or " ":ref:`doc-comment ` (``#:``) that are attributes of the target " "class (i.e. not inherited)." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:640 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:645 msgid "" "To generate automatic documentation for members inherited from base classes," " use the ``:inherited-members:`` option:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:649 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:654 msgid "" "This can be combined with the ``:undoc-members:`` option to generate " "automatic documentation for *all* available members of the class." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:652 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:657 msgid "" "The members of classes listed in the argument to ``:inherited-members:`` are" " excluded from the automatic documentation. This defaults to " @@ -563,105 +562,105 @@ msgid "" "as the argument." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:658 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:663 msgid "" "For example; If your class ``MyList`` is derived from ``list`` class and you" " don't want to document ``list.__len__()``, you should specify a option " "``:inherited-members: list`` to avoid special members of list class." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:664 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:669 msgid "" "Should any of the inherited members use a format other than reStructuredText" " for their docstrings, there may be markup warnings or errors." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:670 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:675 msgid "" "``:inherited-members:`` now takes the name of a base class to exclude as an " "argument." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:674 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:679 msgid "A comma separated list of base class names can be used." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:680 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:685 msgid "" "Generate automatic documentation for members of the target class that don't " "have a docstring or doc-comment. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:693 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:698 msgid "" "Generate automatic documentation for private members of the target class. " "This includes names with a leading underscore (e.g. ``_private``) and those " "members explicitly marked as private with ``:meta private:``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:713 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:718 msgid "The option can now take arguments." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:719 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:724 msgid "" "Generate automatic documentation for special members of the target class, " -"also known as :ref:`\"dunder\" names `. This includes " -"all names enclosed with a double-underscore, e.g. ``__special__``:" +"also known as :ref:`'dunder' names `. This includes all" +" names enclosed with a double-underscore, e.g. ``__special__``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:753 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:758 msgid "``'alphabetical'``: Use simple alphabetical order." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:755 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:760 msgid "" "``'groupwise'``: Group by object type (class, function, etc), use " "alphabetical order within groups." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:758 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:763 msgid "" "``'bysource'``: Use the order of objects in the module's source. The " "``__all__`` variable can be used to override this order." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:772 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:777 msgid "Insert the class's base classes after the class signature." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:778 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:783 msgid "Automatically document function-like objects" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:785 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:790 msgid "" "Document a function, method, property, or decorator. By default, the " "directive only inserts the docstring of the function itself:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:800 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:874 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:805 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:879 msgid "" "The directive can also contain content of its own, which will be inserted " "into the resulting non-auto directive source after the docstring." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:804 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:809 msgid "" "Therefore, you can also mix automatic and non-automatic documentation, as " "follows:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:813 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:818 msgid ":rst:dir:`autodecorator`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:815 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:820 msgid ":rst:dir:`autoproperty`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:820 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:825 msgid "" "If you document decorated functions or methods, keep in mind that " "``autodoc`` retrieves its docstrings by importing the module and inspecting " @@ -670,30 +669,30 @@ msgid "" "the original ``__doc__`` to the new function." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:848 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:853 msgid "Do not generate an index entry for the documented function." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:854 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:859 msgid "Automatically document attributes or data" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:859 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:864 msgid "" "Document a module level variable or constant ('data') or class attribute. By" " default, the directive only inserts the docstring of the variable itself:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:887 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:892 msgid "" ":rst:dir:`autodata` and :rst:dir:`autoattribute` can now extract docstrings." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:890 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:895 msgid "Doc-comments are now allowed on the same line of an assignment." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:908 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:913 msgid "" "By default, ``autodoc`` attempts to obtain the type annotation and value of " "the variable by introspection, displaying it after the variable's name. To " @@ -701,165 +700,225 @@ msgid "" "argument to ``annotation``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:914 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:919 msgid "" "For example, if the runtime value of ``FILE_MODE`` is ``0o755``, the " "displayed value will be ``493`` (as ``oct(493) == '0o755'``). This can be " "fixed by setting ``:annotation: = 0o755``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:918 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:923 msgid "" -"If ``annotation`` is used without arguments, no value or type hint will be " -"shown for the variable." +"If ``:annotation:`` is used without arguments, no value or type hint will be" +" shown for the variable." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:925 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:930 msgid "" -"To display the type hint of the variable without a value, use the ``no-" -"value`` option. If both the ``annotation`` and ``no-value`` options are " -"used, ``no-value`` has no effect." +"To display the type hint of the variable without a value, use the ``:no-" +"value:`` option. If both the ``:annotation:`` and ``:no-value:`` options are" +" used, ``:no-value:`` has no effect." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:932 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:937 msgid "Configuration" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:934 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:939 msgid "There are also config values that you can set:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:938 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:0 +msgid "Type" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:0 +msgid "Default" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:945 msgid "" "This value selects what content will be inserted into the main body of an " ":rst:dir:`autoclass` directive. The possible values are:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:941 -msgid "``\"class\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:948 +msgid "``'class'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:942 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:949 msgid "" -"Only the class' docstring is inserted. This is the default. You can still " -"document ``__init__`` as a separate method using :rst:dir:`automethod` or " -"the ``members`` option to :rst:dir:`autoclass`." +"Only the class' docstring is inserted. You can still document ``__init__`` " +"as a separate method using :rst:dir:`automethod` or the ``members`` option " +"to :rst:dir:`autoclass`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:945 -msgid "``\"both\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:952 +msgid "``'both'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:946 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:953 msgid "" "Both the class' and the ``__init__`` method's docstring are concatenated and" " inserted." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:948 -msgid "``\"init\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:955 +msgid "``'init'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:949 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:956 msgid "Only the ``__init__`` method's docstring is inserted." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:953 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:960 msgid "" "If the class has no ``__init__`` method or if the ``__init__`` method's " "docstring is empty, but the class has a ``__new__`` method's docstring, it " "is used instead." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:961 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:970 msgid "" "This value selects how the signature will be displayed for the class defined" " by :rst:dir:`autoclass` directive. The possible values are:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:964 -msgid "``\"mixed\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:973 +msgid "``'mixed'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:965 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:974 msgid "Display the signature with the class name." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:966 -msgid "``\"separated\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:975 +msgid "``'separated'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:967 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:976 msgid "Display the signature as a method." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:969 -msgid "The default is ``\"mixed\"``." -msgstr "" - -#: ../../sphinx/doc/usage/extensions/autodoc.rst:975 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:984 msgid "" -"This value selects if automatically documented members are sorted " -"alphabetical (value ``'alphabetical'``), by member type (value " -"``'groupwise'``) or by source order (value ``'bysource'``). The default is " -"alphabetical." +"Define the order in which :rst:dir:`automodule` and :rst:dir:`autoclass` " +"members are listed. Supported values are:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:984 -msgid "Support for ``'bysource'``." +#: ../../sphinx/doc/usage/extensions/autodoc.rst:987 +msgid "``'alphabetical'``: Use alphabetical order." msgstr "" #: ../../sphinx/doc/usage/extensions/autodoc.rst:989 +msgid "``'groupwise'``: order by member type. The order is:" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:991 +msgid "for modules, exceptions, classes, functions, data" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:992 +msgid "for classes: methods, then properties and attributes" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:994 +msgid "Members are ordered alphabetically within groups." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:996 msgid "" -"This value is a list of autodoc directive flags that should be automatically" -" applied to all autodoc directives. The supported flags are ``'members'``, " -"``'undoc-members'``, ``'private-members'``, ``'special-members'``, " -"``'inherited-members'``, ``'show-inheritance'``, ``'ignore-module-all'`` and" -" ``'exclude-members'``." +"``'bysource'``: Use the order in which the members appear in the source " +"code. This requires that the module must be a Python module with the source " +"code available." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:999 -msgid "Integrated into :confval:`autodoc_default_options`." +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1002 +msgid "Support for ``'bysource'``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1003 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1009 msgid "" "The default options for autodoc directives. They are applied to all autodoc" " directives automatically. It must be a dictionary which maps option names " "to the values. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1017 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1023 msgid "" "Setting ``None`` or ``True`` to the value is equivalent to giving only the " "option name to the directives." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1020 -msgid "" -"The supported options are ``'members'``, ``'member-order'``, ``'undoc-" -"members'``, ``'private-members'``, ``'special-members'``, ``'inherited-" -"members'``, ``'show-inheritance'``, ``'ignore-module-all'``, ``'imported-" -"members'``, ``'exclude-members'``, ``'class-doc-from'`` and ``'no-value'``." +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1026 +msgid "The supported options are:" msgstr "" #: ../../sphinx/doc/usage/extensions/autodoc.rst:1028 -msgid "Accepts ``True`` as a value." +msgid "``'members'``: See :rst:dir:`automodule:members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1029 +msgid "``'undoc-members'`` See :rst:dir:`automodule:undoc-members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1030 +msgid "``'private-members'``: See :rst:dir:`automodule:private-members`." msgstr "" #: ../../sphinx/doc/usage/extensions/autodoc.rst:1031 -msgid "Added ``'imported-members'``." +msgid "``'special-members'``: See :rst:dir:`automodule:special-members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1032 +msgid "``'inherited-members'``: See :rst:dir:`autoclass:inherited-members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1033 +msgid "``'imported-members'``: See :rst:dir:`automodule:imported-members`." msgstr "" #: ../../sphinx/doc/usage/extensions/autodoc.rst:1034 -msgid "Added ``'class-doc-from'``." +msgid "``'exclude-members'``: See :rst:dir:`automodule:exclude-members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1035 +msgid "``'ignore-module-all'``: See :rst:dir:`automodule:ignore-module-all`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1036 +msgid "``'member-order'``: See :rst:dir:`automodule:member-order`." msgstr "" #: ../../sphinx/doc/usage/extensions/autodoc.rst:1037 +msgid "``'show-inheritance'``: See :rst:dir:`autoclass:show-inheritance`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1038 +msgid "``'class-doc-from'``: See :rst:dir:`autoclass:class-doc-from`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1039 +msgid "``'no-value'``: See :rst:dir:`autodata:no-value`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1043 +msgid "Accepts ``True`` as a value." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1046 +msgid "Added ``'imported-members'``." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1049 +msgid "Added ``'class-doc-from'``." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1052 msgid "Added ``'no-value'``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1042 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1059 msgid "" "Functions imported from C modules cannot be introspected, and therefore the " "signature for such functions cannot be automatically determined. However, " @@ -867,7 +926,7 @@ msgid "" "the function's docstring." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1047 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1064 msgid "" "If this boolean value is set to ``True`` (which is the default), autodoc " "will look at the first line of the docstring for functions and methods, and " @@ -875,22 +934,22 @@ msgid "" "from the docstring content." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1052 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1069 msgid "" "autodoc will continue to look for multiple signature lines, stopping at the " "first line that does not look like a signature. This is useful for declaring" " overloaded function signatures." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1059 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1076 msgid "Support overloaded signatures" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1063 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1080 msgid "Overloaded signatures do not need to be separated by a backslash" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1067 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1086 msgid "" "This value contains a list of modules to be mocked up. This is useful when " "some external dependencies are not met at build time and break the building " @@ -898,198 +957,194 @@ msgid "" "themselves and omit the sub-modules:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1076 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1095 msgid "Will mock all imports under the ``django`` package." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1080 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1099 msgid "" "This config value only requires to declare the top-level modules that should" " be mocked." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1086 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1107 msgid "" "This value controls how to represent typehints. The setting takes the " "following values:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1089 -msgid "``'signature'`` -- Show typehints in the signature (default)" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1110 +msgid "``'signature'`` -- Show typehints in the signature" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1090 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1111 msgid "" "``'description'`` -- Show typehints as content of the function or method The" " typehints of overloaded functions or methods will still be represented in " "the signature." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1093 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1114 msgid "``'none'`` -- Do not show typehints" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1094 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1115 msgid "" "``'both'`` -- Show typehints in the signature and as content of the function" " or method" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1097 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1118 msgid "" "Overloaded functions or methods will not have typehints included in the " "description because it is impossible to accurately represent all possible " "overloads as a list of parameters." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1104 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1125 msgid "New option ``'description'`` is added." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1108 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1129 msgid "New option ``'both'`` is added." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1112 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1135 msgid "" "This value controls whether the types of undocumented parameters and return " -"values are documented when ``autodoc_typehints`` is set to ``description``." +"values are documented when :confval:`autodoc_typehints` is set to " +"``'description'``. Supported values:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1115 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1140 msgid "" -"The default value is ``\"all\"``, meaning that types are documented for all " -"parameters and return values, whether they are documented or not." +"``'all'``: Types are documented for all parameters and return values, " +"whether they are documented or not." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1118 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1143 msgid "" -"When set to ``\"documented\"``, types will only be documented for a " -"parameter or a return value that is already documented by the docstring." +"``'documented'``: Types will only be documented for a parameter or a return " +"value that is already documented by the docstring." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1121 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1146 msgid "" -"With ``\"documented_params\"``, parameter types will only be annotated if " -"the parameter is documented in the docstring. The return type is always " +"``'documented_params'``: Parameter types will only be annotated if the " +"parameter is documented in the docstring. The return type is always " "annotated (except if it is ``None``)." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1129 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1155 msgid "New option ``'documented_params'`` is added." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1133 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1161 msgid "" "A dictionary for users defined `type aliases`__ that maps a type name to the" " full-qualified object name. It is used to keep type aliases not evaluated " -"in the document. Defaults to empty (``{}``)." +"in the document." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1137 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1165 msgid "" "The type aliases are only available if your program enables :pep:`Postponed " "Evaluation of Annotations (PEP 563) <563>` feature via ``from __future__ " "import annotations``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1141 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1169 msgid "For example, there is code using a type alias:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1152 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1180 msgid "" "If ``autodoc_type_aliases`` is not set, autodoc will generate internal mark-" "up from this code as following:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1161 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1189 msgid "" "If you set ``autodoc_type_aliases`` as ``{'AliasType': " "'your.module.AliasType'}``, it generates the following document internally:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1176 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1206 msgid "" "This value controls the format of typehints. The setting takes the " "following values:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1179 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1209 msgid "" "``'fully-qualified'`` -- Show the module name and its name of typehints" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1180 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1210 msgid "" "``'short'`` -- Suppress the leading module names of the typehints (e.g. " -"``io.StringIO`` -> ``StringIO``) (default)" +"``io.StringIO`` -> ``StringIO``)" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1187 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1217 msgid "The default setting was changed to ``'short'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1191 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1223 msgid "" "If True, the default argument values of functions will be not evaluated on " "generating document. It preserves them as is in the source code." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1196 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1228 msgid "" "Added as an experimental feature. This will be integrated into autodoc core" " in the future." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1201 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1235 msgid "" "This value controls the behavior of :option:`sphinx-build --fail-on-warning`" " during importing modules. If ``False`` is given, autodoc forcedly " -"suppresses the error if the imported module emits warnings. By default, " -"``True``." +"suppresses the error if the imported module emits warnings." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1206 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1240 msgid "" "This option now has no effect as :option:`!--fail-on-warning` no longer " "exits early." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1212 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1248 msgid "" "This value controls the docstrings inheritance. If set to True the docstring" " for classes or methods, if not explicitly set, is inherited from parents." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1216 -msgid "The default is ``True``." -msgstr "" - -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1223 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1259 msgid "" -":mod:`autodoc` supports to suppress warning messages via " -":confval:`suppress_warnings`. It allows following warnings types in " -"addition:" +":mod:`autodoc` supports suppressing warning messages via " +":confval:`suppress_warnings`. It defines the following additional warnings " +"types:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1227 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1263 msgid "autodoc" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1228 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1264 msgid "autodoc.import_object" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1232 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1268 msgid "Docstring preprocessing" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1234 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1270 msgid "autodoc provides the following additional events:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1240 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1276 msgid "" "Emitted when autodoc has read and processed a docstring. *lines* is a list " "of strings -- the lines of the processed docstring -- that the event handler" @@ -1100,41 +1155,40 @@ msgstr "" msgid "Parameters" msgstr "Параметры" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1244 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1263 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1275 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1304 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1336 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1280 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1299 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1311 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1340 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1372 msgid "the Sphinx application object" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1245 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1276 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1337 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1281 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1312 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1373 msgid "" -"the type of the object which the docstring belongs to (one of " -"``\"module\"``, ``\"class\"``, ``\"exception\"``, ``\"function\"``, " -"``\"method\"``, ``\"attribute\"``)" +"the type of the object which the docstring belongs to (one of ``'module'``, " +"``'class'``, ``'exception'``, ``'function'``, ``'method'``, ``'attribute'``)" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1248 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1279 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1305 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1340 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1284 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1315 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1341 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1376 msgid "the fully qualified name of the object" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1249 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1264 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1280 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1306 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1341 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1285 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1300 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1316 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1342 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1377 msgid "the object itself" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1250 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1281 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1344 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1286 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1317 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1380 msgid "" "the options given to the directive: an object with attributes " "``inherited_members``, ``undoc_members``, ``show_inheritance`` and ``no-" @@ -1142,41 +1196,41 @@ msgid "" "directive" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1254 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1290 msgid "the lines of the docstring, see above" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1260 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1296 msgid "" "Emitted before autodoc formats a signature for an object. The event handler " "can modify an object to change its signature." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1265 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1301 msgid "a boolean indicates an object is bound method or not" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1271 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1307 msgid "" "Emitted when autodoc has formatted a signature for an object. The event " "handler can return a new tuple ``(signature, return_annotation)`` to change " "what Sphinx puts into the output." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1285 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1321 msgid "" -"function signature, as a string of the form ``\"(parameter_1, " -"parameter_2)\"``, or ``None`` if introspection didn't succeed and signature " +"function signature, as a string of the form ``'(parameter_1, " +"parameter_2)'``, or ``None`` if introspection didn't succeed and signature " "wasn't specified in the directive." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1288 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1324 msgid "" -"function return annotation as a string of the form ``\" -> annotation\"``, " -"or ``None`` if there is no return annotation" +"function return annotation as a string of the form ``' -> annotation'``, or " +"``None`` if there is no return annotation" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1291 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1327 msgid "" "The :mod:`sphinx.ext.autodoc` module provides factory functions for commonly" " needed docstring processing in event :event:`autodoc-process-docstring`:" @@ -1217,7 +1271,7 @@ msgid "" " be processed." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1299 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1335 msgid "" "Emitted when autodoc has read and processed a class to determine the base-" "classes. *bases* is a list of classes that the event handler can modify " @@ -1225,38 +1279,38 @@ msgid "" "if ``show-inheritance`` option given." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1307 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1343 msgid "the options given to the class directive" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1308 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1344 msgid "the list of base classes signature. see above." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1313 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1349 msgid "" "``bases`` can contain a string as a base class name. It will be processed as" " reStructuredText." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1318 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1354 msgid "Skipping members" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1320 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1356 msgid "" "autodoc allows the user to define a custom method for determining whether a " "member should be included in the documentation by using the following event:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1327 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1363 msgid "" "Emitted when autodoc has to decide whether a member should be included in " "the documentation. The member is excluded if a handler returns ``True``. " "It is included if the handler returns ``False``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1331 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1367 msgid "" "If more than one enabled extension handles the ``autodoc-skip-member`` " "event, autodoc will use the first non-``None`` value returned by a handler. " @@ -1264,7 +1318,7 @@ msgid "" "autodoc and other enabled extensions." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1342 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1378 msgid "" "a boolean indicating if autodoc will skip this member if the user handler " "does not override the decision" diff --git a/locale/sr/LC_MESSAGES/changes/1.8.po b/locale/sr/LC_MESSAGES/changes/1.8.po index a6c11bf0e5..e12fe8ec00 100644 --- a/locale/sr/LC_MESSAGES/changes/1.8.po +++ b/locale/sr/LC_MESSAGES/changes/1.8.po @@ -11,7 +11,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-10-01 00:54+0000\n" +"POT-Creation-Date: 2024-10-03 00:49+0000\n" "PO-Revision-Date: 2024-07-31 00:36+0000\n" "Last-Translator: Vladimir Milovanović , 2024\n" "Language-Team: Serbian (https://app.transifex.com/sphinx-doc/teams/15434/sr/)\n" @@ -400,7 +400,7 @@ msgstr "" #: ../../sphinx/doc/changes/1.8.rst:150 msgid "" "#5421: autodoc emits deprecation warning for " -":confval:`autodoc_default_flags`" +":confval:`!autodoc_default_flags`" msgstr "" #: ../../sphinx/doc/changes/1.8.rst:151 @@ -668,7 +668,7 @@ msgid ":confval:`!source_parsers` is deprecated" msgstr "" #: ../../sphinx/doc/changes/1.8.rst:254 -msgid ":confval:`autodoc_default_flags` is deprecated" +msgid ":confval:`!autodoc_default_flags` is deprecated" msgstr "" #: ../../sphinx/doc/changes/1.8.rst:255 diff --git a/locale/sr/LC_MESSAGES/changes/index.po b/locale/sr/LC_MESSAGES/changes/index.po index 40a1f82041..ffdade5f0c 100644 --- a/locale/sr/LC_MESSAGES/changes/index.po +++ b/locale/sr/LC_MESSAGES/changes/index.po @@ -11,7 +11,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-09-28 00:48+0000\n" +"POT-Creation-Date: 2024-10-03 00:49+0000\n" "PO-Revision-Date: 2024-07-31 00:36+0000\n" "Last-Translator: Vladimir Milovanović , 2024\n" "Language-Team: Serbian (https://app.transifex.com/sphinx-doc/teams/15434/sr/)\n" @@ -238,11 +238,18 @@ msgid "" ":rst:dir:`py:module` directives. Patch by Stephen Finucane." msgstr "" -#: ../../sphinx/CHANGES.rst:112 +#: ../../sphinx/CHANGES.rst:110 +msgid "" +"#12916: Restore support for custom templates named with the legacy ``_t`` " +"suffix during ``apidoc`` RST rendering (regression in 7.4.0). Patch by James" +" Addison." +msgstr "" + +#: ../../sphinx/CHANGES.rst:115 msgid "Testing" msgstr "" -#: ../../sphinx/CHANGES.rst:114 +#: ../../sphinx/CHANGES.rst:117 msgid "" "#12141: Migrate from the deprecated ``karma`` JavaScript test framework to " "the actively-maintained ``jasmine`` framework. Test coverage is unaffected." diff --git a/locale/sr/LC_MESSAGES/extdev/deprecated.po b/locale/sr/LC_MESSAGES/extdev/deprecated.po index c89870f3bc..4e9963fe80 100644 --- a/locale/sr/LC_MESSAGES/extdev/deprecated.po +++ b/locale/sr/LC_MESSAGES/extdev/deprecated.po @@ -11,7 +11,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-09-02 00:47+0000\n" +"POT-Creation-Date: 2024-10-03 00:50+0000\n" "PO-Revision-Date: 2019-03-09 18:04+0000\n" "Last-Translator: Vladimir Milovanović , 2021\n" "Language-Team: Serbian (https://app.transifex.com/sphinx-doc/teams/15434/sr/)\n" @@ -2852,7 +2852,7 @@ msgid ":meth:`~sphinx.application.Sphinx.add_js_file`" msgstr "" #: ../../sphinx/doc/extdev/deprecated.rst:1457 -msgid ":confval:`autodoc_default_flags`" +msgid ":confval:`!autodoc_default_flags`" msgstr "" #: ../../sphinx/doc/extdev/deprecated.rst:1460 diff --git a/locale/sr/LC_MESSAGES/usage/domains/restructuredtext.po b/locale/sr/LC_MESSAGES/usage/domains/restructuredtext.po index de3ef16928..5d718f6b2d 100644 --- a/locale/sr/LC_MESSAGES/usage/domains/restructuredtext.po +++ b/locale/sr/LC_MESSAGES/usage/domains/restructuredtext.po @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-09-15 00:53+0000\n" +"POT-Creation-Date: 2024-10-03 00:49+0000\n" "PO-Revision-Date: 2023-10-03 00:37+0000\n" "Language-Team: Serbian (https://app.transifex.com/sphinx-doc/teams/15434/sr/)\n" "MIME-Version: 1.0\n" @@ -75,3 +75,20 @@ msgstr "" #: ../../sphinx/doc/usage/domains/restructuredtext.rst:97 msgid "These roles are provided to refer to the described objects:" msgstr "" + +#: ../../sphinx/doc/usage/domains/restructuredtext.rst:101 +msgid "Reference directives and directive options. Examples:" +msgstr "" + +#: ../../sphinx/doc/usage/domains/restructuredtext.rst:103 +msgid "Use ``:rst:dir:`my-directive``` to reference a directive." +msgstr "" + +#: ../../sphinx/doc/usage/domains/restructuredtext.rst:104 +msgid "" +"Use ``:rst:dir:`my-directive:my-option``` to reference a directive option." +msgstr "" + +#: ../../sphinx/doc/usage/domains/restructuredtext.rst:109 +msgid "Reference a role. Example: ``:rst:role:`my-role```." +msgstr "" diff --git a/locale/sr/LC_MESSAGES/usage/extensions/autodoc.po b/locale/sr/LC_MESSAGES/usage/extensions/autodoc.po index fae31868af..772c884bf2 100644 --- a/locale/sr/LC_MESSAGES/usage/extensions/autodoc.po +++ b/locale/sr/LC_MESSAGES/usage/extensions/autodoc.po @@ -11,7 +11,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-10-02 00:49+0000\n" +"POT-Creation-Date: 2024-10-03 00:50+0000\n" "PO-Revision-Date: 2018-06-26 15:58+0000\n" "Last-Translator: Vladimir Milovanović , 2020\n" "Language-Team: Serbian (https://app.transifex.com/sphinx-doc/teams/15434/sr/)\n" @@ -25,26 +25,26 @@ msgstr "" msgid ":mod:`sphinx.ext.autodoc` -- Include documentation from docstrings" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:12 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:15 msgid "" "This extension can import the modules you are documenting, and pull in " "documentation from docstrings in a semi-automatic way." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:17 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:20 msgid "" ":mod:`~sphinx.ext.autodoc` **imports** the modules to be documented. If any " "modules have side effects on import, these will be executed by ``autodoc`` " "when :program:`sphinx-build` is run." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:21 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:24 msgid "" "If you document scripts (as opposed to library modules), make sure that the " "main routine is protected by an ``if __name__ == '__main__'`` condition." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:25 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:28 msgid "" "For this to work, the docstrings must of course be written in correct " "reStructuredText. You can then use all of the usual Sphinx markup in the " @@ -54,7 +54,7 @@ msgid "" "auto-generated-looking pure API documentation." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:33 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:36 msgid "" "If you prefer `NumPy`_ or `Google`_ style docstrings over reStructuredText, " "you can also enable the :mod:`napoleon ` extension. " @@ -62,25 +62,25 @@ msgid "" "reStructuredText before ``autodoc`` processes them." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:43 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:46 msgid "Getting started" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:47 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:50 msgid "Setup" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:49 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:52 msgid "" "Activate the plugin by adding ``'sphinx.ext.autodoc'`` to the " ":confval:`extensions` list in :file:`conf.py`:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:61 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:64 msgid "Ensuring the code can be imported" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:63 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:66 msgid "" ":mod:`~sphinx.ext.autodoc` analyses the code and docstrings by introspection" " after **importing the modules**. For importing to work, you have to make " @@ -90,11 +90,11 @@ msgid "" "fail)." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:70 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:73 msgid "There are two ways to ensure this:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:72 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:75 msgid "" "Use an environment that contains your package and Sphinx. This can e.g. be " "your local development environment (with an editable install), or an " @@ -103,14 +103,14 @@ msgid "" "that all dependencies are available." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:78 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:81 msgid "" "It is alternatively possible to patch the Sphinx run so that it can operate " "directly on the sources; e.g. if you want to be able to do a Sphinx build " "from a source checkout." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:82 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:85 msgid "" "Patch :data:`sys.path` in :file:`conf.py` to include your source path. For " "example if you have a repository structure with :file:`doc/conf.py` and your" @@ -118,17 +118,17 @@ msgid "" "your :file:`conf.py`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:94 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:97 msgid "" "To cope with missing dependencies, specify the missing modules in the " ":confval:`autodoc_mock_imports` setting." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:99 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:102 msgid "Usage" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:101 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:104 msgid "" "You can now use the :ref:`autodoc-directives` to add formatted documentation" " for Python code elements like functions, classes, modules, etc. For " @@ -136,48 +136,48 @@ msgid "" "docstring from the source file, you'd write:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:110 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:113 msgid "" "You can also document whole classes or even modules automatically, using " "member options for the auto directives, like:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:119 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:122 msgid "" "As a hint to autodoc extension, you can put a ``::`` separator between the " "module name and the object name to let autodoc know the correct module, if " "it is ambiguous:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:129 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:132 msgid "Marking objects as public or private" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:131 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:134 msgid "" "autodoc considers a member private if its docstring contains ``:meta " "private:`` in its :ref:`info-field-lists`. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:145 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:148 msgid "" "autodoc considers a member public if its docstring contains ``:meta " "public:`` in its :ref:`info-field-lists`, even if it starts with an " "underscore. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:160 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:163 msgid "" "autodoc considers a variable member does not have any default value if its " "docstring contains ``:meta hide-value:`` in its :ref:`info-field-lists`. " "Example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:174 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:177 msgid "Doc comments and docstrings" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:176 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:179 msgid "" "Python has no built-in support for docstrings for module data members or " "class attributes. To allow documenting these, ``autodoc`` recognises a " @@ -185,7 +185,7 @@ msgid "" " 'documentation comment'." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:181 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:184 msgid "" "These comments start with a colon and an optional space character, ``'#:'`` " "or ``'#: '``. To be recognised, the comments must appear either on the same " @@ -194,28 +194,28 @@ msgid "" "definition." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:188 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:191 msgid "" "For example, all three of the following variables have valid doc-comments:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:202 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:205 msgid "" "Alternatively, ``autodoc`` can recognise a docstring on the line immediately" " following the definition." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:205 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:208 msgid "" "In the the following class definition, all attributes have documentation " "recognised by ``autodoc``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:233 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:236 msgid "Directives" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:235 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:238 msgid "" ":mod:`autodoc` provides several directives that are versions of the usual " ":rst:dir:`py:module`, :rst:dir:`py:class` and so forth. On parsing time, " @@ -224,24 +224,24 @@ msgid "" ":rst:dir:`py:module`, :rst:dir:`py:class` etc. directive." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:244 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:247 msgid "" "Just as :rst:dir:`py:class` respects the current :rst:dir:`py:module`, " ":rst:dir:`autoclass` will also do so. Likewise, :rst:dir:`automethod` will " "respect the current :rst:dir:`py:class`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:250 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:253 msgid "Default directive options" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:252 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:255 msgid "" "To make any of the options described below the default, use the " ":confval:`autodoc_default_options` dictionary in :file:`conf.py`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:255 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:258 msgid "" "If using defaults for the ``:members:``, ``:exclude-members:``, ``:private-" "members:``, or ``:special-members:`` options, setting the option on a " @@ -250,111 +250,111 @@ msgid "" "(``+``), as follows:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:269 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:272 msgid "" "If using :confval:`autodoc_default_options`, the defaults can be disabled " "per-directive with the negated form, :samp:`:no-{option}:` as an option of " "the directive For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:281 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:284 msgid "Automatically document modules" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:285 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:288 msgid "" "Document a module. By default, the directive only inserts the docstring of " "the module itself:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:292 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:526 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:792 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:866 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:295 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:531 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:797 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:871 msgid "will produce source like this:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:300 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:534 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:303 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:539 msgid "" "The directive can also contain content of its own, which will be inserted " "into the resulting non-auto directive source after the docstring (but before" " any automatic member documentation)." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:304 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:538 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:878 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:307 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:543 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:883 msgid "" "Therefore, you can also mix automatic and non-automatic member " "documentation, as follows:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:317 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:567 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:844 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:894 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:320 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:572 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:849 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:899 msgid "Options" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:321 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:324 msgid "" "Do not generate an index entry for the documented module or any auto-" "documented members." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:329 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:332 msgid "" "Indicate platforms on which the module is available. This is identical to " ":rst:dir:`py:module`'s ``:platform:`` option." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:335 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:338 msgid "" "A sentence describing the module's purpose. This is identical to " ":rst:dir:`py:module`'s ``:synopsis:`` option." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:343 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:346 msgid "" "Mark a module as deprecated. This is identical to :rst:dir:`py:module`'s " "``:deprecated:`` option." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:351 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:354 msgid "Do not use ``__all__`` when analysing the module to document." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:356 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:600 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:359 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:605 msgid "Options for selecting members to document" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:360 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:363 msgid "Generate automatic documentation for all members of the target module:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:367 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:370 msgid "" "By default, ``autodoc`` only includes public members with a docstring or " ":ref:`doc-comment ` (``#:``). If ``__all__`` exists, it will be" -" used to define which members are public, unless the ``:ignore-module-all:``" -" option is set." +" used to define which members are public, unless the :rst:dir:`:ignore-" +"module-all: ` option is set." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:372 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:615 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:376 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:620 msgid "" "To only document certain members, an explicit comma-separated list may be " "used as the argument to ``:members:``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:383 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:626 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:387 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:631 msgid "Exclude the given names from the members to document. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:397 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:401 msgid "" "To prevent documentation of imported classes or functions, in an " ":rst:dir:`!automodule` directive with the ``members`` option set, only " @@ -362,198 +362,197 @@ msgid "" "name given to ``automodule`` will be documented." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:402 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:406 msgid "" "Set the ``imported-members`` option if you want to prevent this behavior and" " document all available members." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:405 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:409 msgid "" "Note that attributes from imported modules will not be documented, because " "attribute documentation is discovered by parsing the source file of the " "current module." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:414 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:418 msgid "" "Generate automatic documentation for members of the target module that don't" " have a docstring or doc-comment. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:427 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:431 msgid "" "Generate automatic documentation for private members of the target module. " "This includes names with a leading underscore (e.g. ``_private``) and those " "members explicitly marked as private with ``:meta private:``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:437 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:703 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:441 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:708 msgid "" "To only document certain private members, an explicit comma-separated list " "may be used as the argument to ``:private-members:``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:447 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:475 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:741 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:451 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:479 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:746 msgid "The option can now take a comma-separated list of arguments." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:453 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:457 msgid "" "Generate automatic documentation for special members of the target module, " -"also known as :ref:`\"dunder\" names `. This includes " -"all names enclosed with a double-underscore, e.g. ``__special__``:" +"also known as :ref:`'dunder' names `. This includes all" +" names enclosed with a double-underscore, e.g. ``__special__``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:464 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:730 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:468 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:735 msgid "" "To only document certain special members, an explicit comma-separated list " "may be used as the argument to ``:special-members:``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:479 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:745 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:483 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:750 msgid "Options for documented members" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:483 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:749 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:487 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:754 msgid "" "Choose the ordering of automatically documented members (default: " "``alphabetical``). This overrides the :confval:`autodoc_member_order` " "setting." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:487 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:491 msgid "``alphabetical``: Use simple alphabetical order." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:489 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:493 msgid "" "``groupwise``: Group by object type (class, function, etc), use alphabetical" " order within groups." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:492 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:496 msgid "" "``bysource``: Use the order of objects in the module's source. The " "``__all__`` variable can be used to override this order." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:496 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:762 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:980 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:500 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:767 msgid "" "Note that for source order, the module must be a Python module with the " "source code available." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:500 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:766 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:504 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:771 msgid "Support the ``'bysource'`` option." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:506 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:510 msgid "" -"Enable the ``:show-inheritance:`` option for all members of the module, if " -"``:members:`` is enabled." +"Enable the :rst:dir:`:show-inheritance: ` option" +" for all members of the module, if ``:members:`` is enabled." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:513 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:518 msgid "Automatically document classes or exceptions" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:518 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:523 msgid "" -"Document a class. For exception classes, prefer ``autoexception``. By " +"Document a class. For exception classes, prefer ``.. autoexception::``. By " "default, the directive only inserts the docstring of the class itself:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:551 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:828 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:556 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:833 msgid "Advanced usage" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:552 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:829 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:557 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:834 msgid "" "It is possible to override the signature for explicitly documented callable " "objects (functions, methods, classes) with the regular syntax that will " "override the signature gained from introspection:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:562 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:839 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:567 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:844 msgid "" "This is useful if the signature from the method is hidden by a decorator." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:571 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:898 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:576 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:903 msgid "" "Do not generate an index entry for the documented class or any auto-" "documented members." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:579 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:584 msgid "" "Select which docstring will be used for the main body of the directive. This" " overrides the global value of :confval:`autoclass_content`. The possible " "values are:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:583 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:588 msgid "" "``class``: Only use the class's docstring. The :meth:`!__init__` method can " "be separately documented using the ``:members:`` option or " ":rst:dir:`automethod`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:587 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:592 msgid "``init``: Only use the docstring of the :meth:`!__init__` method." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:589 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:594 msgid "" -"``both`` Use both, appending the docstring of the :meth:`!__init__` method " +"``both``: Use both, appending the docstring of the :meth:`!__init__` method " "to the class's docstring." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:593 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:598 msgid "" "If the :meth:`!__init__` method doesn't exist or has a blank docstring, " "``autodoc`` will attempt to use the :meth:`!__new__` method's docstring, if " "it exists and is not blank." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:604 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:609 msgid "Generate automatic documentation for all members of the target class:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:611 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:616 msgid "" "By default, ``autodoc`` only includes public members with a docstring or " ":ref:`doc-comment ` (``#:``) that are attributes of the target " "class (i.e. not inherited)." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:640 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:645 msgid "" "To generate automatic documentation for members inherited from base classes," " use the ``:inherited-members:`` option:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:649 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:654 msgid "" "This can be combined with the ``:undoc-members:`` option to generate " "automatic documentation for *all* available members of the class." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:652 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:657 msgid "" "The members of classes listed in the argument to ``:inherited-members:`` are" " excluded from the automatic documentation. This defaults to " @@ -562,105 +561,105 @@ msgid "" "as the argument." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:658 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:663 msgid "" "For example; If your class ``MyList`` is derived from ``list`` class and you" " don't want to document ``list.__len__()``, you should specify a option " "``:inherited-members: list`` to avoid special members of list class." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:664 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:669 msgid "" "Should any of the inherited members use a format other than reStructuredText" " for their docstrings, there may be markup warnings or errors." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:670 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:675 msgid "" "``:inherited-members:`` now takes the name of a base class to exclude as an " "argument." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:674 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:679 msgid "A comma separated list of base class names can be used." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:680 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:685 msgid "" "Generate automatic documentation for members of the target class that don't " "have a docstring or doc-comment. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:693 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:698 msgid "" "Generate automatic documentation for private members of the target class. " "This includes names with a leading underscore (e.g. ``_private``) and those " "members explicitly marked as private with ``:meta private:``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:713 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:718 msgid "The option can now take arguments." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:719 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:724 msgid "" "Generate automatic documentation for special members of the target class, " -"also known as :ref:`\"dunder\" names `. This includes " -"all names enclosed with a double-underscore, e.g. ``__special__``:" +"also known as :ref:`'dunder' names `. This includes all" +" names enclosed with a double-underscore, e.g. ``__special__``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:753 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:758 msgid "``'alphabetical'``: Use simple alphabetical order." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:755 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:760 msgid "" "``'groupwise'``: Group by object type (class, function, etc), use " "alphabetical order within groups." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:758 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:763 msgid "" "``'bysource'``: Use the order of objects in the module's source. The " "``__all__`` variable can be used to override this order." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:772 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:777 msgid "Insert the class's base classes after the class signature." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:778 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:783 msgid "Automatically document function-like objects" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:785 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:790 msgid "" "Document a function, method, property, or decorator. By default, the " "directive only inserts the docstring of the function itself:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:800 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:874 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:805 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:879 msgid "" "The directive can also contain content of its own, which will be inserted " "into the resulting non-auto directive source after the docstring." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:804 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:809 msgid "" "Therefore, you can also mix automatic and non-automatic documentation, as " "follows:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:813 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:818 msgid ":rst:dir:`autodecorator`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:815 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:820 msgid ":rst:dir:`autoproperty`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:820 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:825 msgid "" "If you document decorated functions or methods, keep in mind that " "``autodoc`` retrieves its docstrings by importing the module and inspecting " @@ -669,30 +668,30 @@ msgid "" "the original ``__doc__`` to the new function." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:848 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:853 msgid "Do not generate an index entry for the documented function." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:854 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:859 msgid "Automatically document attributes or data" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:859 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:864 msgid "" "Document a module level variable or constant ('data') or class attribute. By" " default, the directive only inserts the docstring of the variable itself:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:887 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:892 msgid "" ":rst:dir:`autodata` and :rst:dir:`autoattribute` can now extract docstrings." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:890 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:895 msgid "Doc-comments are now allowed on the same line of an assignment." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:908 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:913 msgid "" "By default, ``autodoc`` attempts to obtain the type annotation and value of " "the variable by introspection, displaying it after the variable's name. To " @@ -700,165 +699,225 @@ msgid "" "argument to ``annotation``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:914 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:919 msgid "" "For example, if the runtime value of ``FILE_MODE`` is ``0o755``, the " "displayed value will be ``493`` (as ``oct(493) == '0o755'``). This can be " "fixed by setting ``:annotation: = 0o755``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:918 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:923 msgid "" -"If ``annotation`` is used without arguments, no value or type hint will be " -"shown for the variable." +"If ``:annotation:`` is used without arguments, no value or type hint will be" +" shown for the variable." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:925 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:930 msgid "" -"To display the type hint of the variable without a value, use the ``no-" -"value`` option. If both the ``annotation`` and ``no-value`` options are " -"used, ``no-value`` has no effect." +"To display the type hint of the variable without a value, use the ``:no-" +"value:`` option. If both the ``:annotation:`` and ``:no-value:`` options are" +" used, ``:no-value:`` has no effect." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:932 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:937 msgid "Configuration" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:934 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:939 msgid "There are also config values that you can set:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:938 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:0 +msgid "Type" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:0 +msgid "Default" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:945 msgid "" "This value selects what content will be inserted into the main body of an " ":rst:dir:`autoclass` directive. The possible values are:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:941 -msgid "``\"class\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:948 +msgid "``'class'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:942 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:949 msgid "" -"Only the class' docstring is inserted. This is the default. You can still " -"document ``__init__`` as a separate method using :rst:dir:`automethod` or " -"the ``members`` option to :rst:dir:`autoclass`." +"Only the class' docstring is inserted. You can still document ``__init__`` " +"as a separate method using :rst:dir:`automethod` or the ``members`` option " +"to :rst:dir:`autoclass`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:945 -msgid "``\"both\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:952 +msgid "``'both'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:946 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:953 msgid "" "Both the class' and the ``__init__`` method's docstring are concatenated and" " inserted." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:948 -msgid "``\"init\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:955 +msgid "``'init'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:949 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:956 msgid "Only the ``__init__`` method's docstring is inserted." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:953 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:960 msgid "" "If the class has no ``__init__`` method or if the ``__init__`` method's " "docstring is empty, but the class has a ``__new__`` method's docstring, it " "is used instead." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:961 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:970 msgid "" "This value selects how the signature will be displayed for the class defined" " by :rst:dir:`autoclass` directive. The possible values are:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:964 -msgid "``\"mixed\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:973 +msgid "``'mixed'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:965 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:974 msgid "Display the signature with the class name." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:966 -msgid "``\"separated\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:975 +msgid "``'separated'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:967 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:976 msgid "Display the signature as a method." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:969 -msgid "The default is ``\"mixed\"``." -msgstr "" - -#: ../../sphinx/doc/usage/extensions/autodoc.rst:975 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:984 msgid "" -"This value selects if automatically documented members are sorted " -"alphabetical (value ``'alphabetical'``), by member type (value " -"``'groupwise'``) or by source order (value ``'bysource'``). The default is " -"alphabetical." +"Define the order in which :rst:dir:`automodule` and :rst:dir:`autoclass` " +"members are listed. Supported values are:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:984 -msgid "Support for ``'bysource'``." +#: ../../sphinx/doc/usage/extensions/autodoc.rst:987 +msgid "``'alphabetical'``: Use alphabetical order." msgstr "" #: ../../sphinx/doc/usage/extensions/autodoc.rst:989 +msgid "``'groupwise'``: order by member type. The order is:" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:991 +msgid "for modules, exceptions, classes, functions, data" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:992 +msgid "for classes: methods, then properties and attributes" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:994 +msgid "Members are ordered alphabetically within groups." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:996 msgid "" -"This value is a list of autodoc directive flags that should be automatically" -" applied to all autodoc directives. The supported flags are ``'members'``, " -"``'undoc-members'``, ``'private-members'``, ``'special-members'``, " -"``'inherited-members'``, ``'show-inheritance'``, ``'ignore-module-all'`` and" -" ``'exclude-members'``." +"``'bysource'``: Use the order in which the members appear in the source " +"code. This requires that the module must be a Python module with the source " +"code available." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:999 -msgid "Integrated into :confval:`autodoc_default_options`." +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1002 +msgid "Support for ``'bysource'``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1003 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1009 msgid "" "The default options for autodoc directives. They are applied to all autodoc" " directives automatically. It must be a dictionary which maps option names " "to the values. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1017 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1023 msgid "" "Setting ``None`` or ``True`` to the value is equivalent to giving only the " "option name to the directives." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1020 -msgid "" -"The supported options are ``'members'``, ``'member-order'``, ``'undoc-" -"members'``, ``'private-members'``, ``'special-members'``, ``'inherited-" -"members'``, ``'show-inheritance'``, ``'ignore-module-all'``, ``'imported-" -"members'``, ``'exclude-members'``, ``'class-doc-from'`` and ``'no-value'``." +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1026 +msgid "The supported options are:" msgstr "" #: ../../sphinx/doc/usage/extensions/autodoc.rst:1028 -msgid "Accepts ``True`` as a value." +msgid "``'members'``: See :rst:dir:`automodule:members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1029 +msgid "``'undoc-members'`` See :rst:dir:`automodule:undoc-members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1030 +msgid "``'private-members'``: See :rst:dir:`automodule:private-members`." msgstr "" #: ../../sphinx/doc/usage/extensions/autodoc.rst:1031 -msgid "Added ``'imported-members'``." +msgid "``'special-members'``: See :rst:dir:`automodule:special-members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1032 +msgid "``'inherited-members'``: See :rst:dir:`autoclass:inherited-members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1033 +msgid "``'imported-members'``: See :rst:dir:`automodule:imported-members`." msgstr "" #: ../../sphinx/doc/usage/extensions/autodoc.rst:1034 -msgid "Added ``'class-doc-from'``." +msgid "``'exclude-members'``: See :rst:dir:`automodule:exclude-members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1035 +msgid "``'ignore-module-all'``: See :rst:dir:`automodule:ignore-module-all`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1036 +msgid "``'member-order'``: See :rst:dir:`automodule:member-order`." msgstr "" #: ../../sphinx/doc/usage/extensions/autodoc.rst:1037 +msgid "``'show-inheritance'``: See :rst:dir:`autoclass:show-inheritance`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1038 +msgid "``'class-doc-from'``: See :rst:dir:`autoclass:class-doc-from`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1039 +msgid "``'no-value'``: See :rst:dir:`autodata:no-value`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1043 +msgid "Accepts ``True`` as a value." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1046 +msgid "Added ``'imported-members'``." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1049 +msgid "Added ``'class-doc-from'``." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1052 msgid "Added ``'no-value'``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1042 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1059 msgid "" "Functions imported from C modules cannot be introspected, and therefore the " "signature for such functions cannot be automatically determined. However, " @@ -866,7 +925,7 @@ msgid "" "the function's docstring." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1047 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1064 msgid "" "If this boolean value is set to ``True`` (which is the default), autodoc " "will look at the first line of the docstring for functions and methods, and " @@ -874,22 +933,22 @@ msgid "" "from the docstring content." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1052 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1069 msgid "" "autodoc will continue to look for multiple signature lines, stopping at the " "first line that does not look like a signature. This is useful for declaring" " overloaded function signatures." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1059 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1076 msgid "Support overloaded signatures" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1063 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1080 msgid "Overloaded signatures do not need to be separated by a backslash" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1067 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1086 msgid "" "This value contains a list of modules to be mocked up. This is useful when " "some external dependencies are not met at build time and break the building " @@ -897,198 +956,194 @@ msgid "" "themselves and omit the sub-modules:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1076 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1095 msgid "Will mock all imports under the ``django`` package." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1080 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1099 msgid "" "This config value only requires to declare the top-level modules that should" " be mocked." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1086 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1107 msgid "" "This value controls how to represent typehints. The setting takes the " "following values:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1089 -msgid "``'signature'`` -- Show typehints in the signature (default)" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1110 +msgid "``'signature'`` -- Show typehints in the signature" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1090 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1111 msgid "" "``'description'`` -- Show typehints as content of the function or method The" " typehints of overloaded functions or methods will still be represented in " "the signature." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1093 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1114 msgid "``'none'`` -- Do not show typehints" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1094 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1115 msgid "" "``'both'`` -- Show typehints in the signature and as content of the function" " or method" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1097 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1118 msgid "" "Overloaded functions or methods will not have typehints included in the " "description because it is impossible to accurately represent all possible " "overloads as a list of parameters." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1104 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1125 msgid "New option ``'description'`` is added." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1108 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1129 msgid "New option ``'both'`` is added." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1112 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1135 msgid "" "This value controls whether the types of undocumented parameters and return " -"values are documented when ``autodoc_typehints`` is set to ``description``." +"values are documented when :confval:`autodoc_typehints` is set to " +"``'description'``. Supported values:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1115 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1140 msgid "" -"The default value is ``\"all\"``, meaning that types are documented for all " -"parameters and return values, whether they are documented or not." +"``'all'``: Types are documented for all parameters and return values, " +"whether they are documented or not." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1118 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1143 msgid "" -"When set to ``\"documented\"``, types will only be documented for a " -"parameter or a return value that is already documented by the docstring." +"``'documented'``: Types will only be documented for a parameter or a return " +"value that is already documented by the docstring." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1121 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1146 msgid "" -"With ``\"documented_params\"``, parameter types will only be annotated if " -"the parameter is documented in the docstring. The return type is always " +"``'documented_params'``: Parameter types will only be annotated if the " +"parameter is documented in the docstring. The return type is always " "annotated (except if it is ``None``)." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1129 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1155 msgid "New option ``'documented_params'`` is added." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1133 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1161 msgid "" "A dictionary for users defined `type aliases`__ that maps a type name to the" " full-qualified object name. It is used to keep type aliases not evaluated " -"in the document. Defaults to empty (``{}``)." +"in the document." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1137 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1165 msgid "" "The type aliases are only available if your program enables :pep:`Postponed " "Evaluation of Annotations (PEP 563) <563>` feature via ``from __future__ " "import annotations``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1141 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1169 msgid "For example, there is code using a type alias:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1152 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1180 msgid "" "If ``autodoc_type_aliases`` is not set, autodoc will generate internal mark-" "up from this code as following:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1161 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1189 msgid "" "If you set ``autodoc_type_aliases`` as ``{'AliasType': " "'your.module.AliasType'}``, it generates the following document internally:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1176 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1206 msgid "" "This value controls the format of typehints. The setting takes the " "following values:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1179 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1209 msgid "" "``'fully-qualified'`` -- Show the module name and its name of typehints" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1180 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1210 msgid "" "``'short'`` -- Suppress the leading module names of the typehints (e.g. " -"``io.StringIO`` -> ``StringIO``) (default)" +"``io.StringIO`` -> ``StringIO``)" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1187 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1217 msgid "The default setting was changed to ``'short'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1191 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1223 msgid "" "If True, the default argument values of functions will be not evaluated on " "generating document. It preserves them as is in the source code." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1196 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1228 msgid "" "Added as an experimental feature. This will be integrated into autodoc core" " in the future." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1201 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1235 msgid "" "This value controls the behavior of :option:`sphinx-build --fail-on-warning`" " during importing modules. If ``False`` is given, autodoc forcedly " -"suppresses the error if the imported module emits warnings. By default, " -"``True``." +"suppresses the error if the imported module emits warnings." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1206 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1240 msgid "" "This option now has no effect as :option:`!--fail-on-warning` no longer " "exits early." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1212 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1248 msgid "" "This value controls the docstrings inheritance. If set to True the docstring" " for classes or methods, if not explicitly set, is inherited from parents." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1216 -msgid "The default is ``True``." -msgstr "" - -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1223 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1259 msgid "" -":mod:`autodoc` supports to suppress warning messages via " -":confval:`suppress_warnings`. It allows following warnings types in " -"addition:" +":mod:`autodoc` supports suppressing warning messages via " +":confval:`suppress_warnings`. It defines the following additional warnings " +"types:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1227 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1263 msgid "autodoc" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1228 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1264 msgid "autodoc.import_object" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1232 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1268 msgid "Docstring preprocessing" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1234 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1270 msgid "autodoc provides the following additional events:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1240 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1276 msgid "" "Emitted when autodoc has read and processed a docstring. *lines* is a list " "of strings -- the lines of the processed docstring -- that the event handler" @@ -1099,41 +1154,40 @@ msgstr "" msgid "Parameters" msgstr "Параметри" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1244 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1263 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1275 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1304 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1336 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1280 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1299 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1311 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1340 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1372 msgid "the Sphinx application object" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1245 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1276 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1337 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1281 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1312 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1373 msgid "" -"the type of the object which the docstring belongs to (one of " -"``\"module\"``, ``\"class\"``, ``\"exception\"``, ``\"function\"``, " -"``\"method\"``, ``\"attribute\"``)" +"the type of the object which the docstring belongs to (one of ``'module'``, " +"``'class'``, ``'exception'``, ``'function'``, ``'method'``, ``'attribute'``)" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1248 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1279 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1305 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1340 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1284 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1315 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1341 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1376 msgid "the fully qualified name of the object" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1249 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1264 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1280 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1306 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1341 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1285 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1300 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1316 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1342 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1377 msgid "the object itself" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1250 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1281 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1344 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1286 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1317 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1380 msgid "" "the options given to the directive: an object with attributes " "``inherited_members``, ``undoc_members``, ``show_inheritance`` and ``no-" @@ -1141,41 +1195,41 @@ msgid "" "directive" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1254 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1290 msgid "the lines of the docstring, see above" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1260 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1296 msgid "" "Emitted before autodoc formats a signature for an object. The event handler " "can modify an object to change its signature." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1265 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1301 msgid "a boolean indicates an object is bound method or not" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1271 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1307 msgid "" "Emitted when autodoc has formatted a signature for an object. The event " "handler can return a new tuple ``(signature, return_annotation)`` to change " "what Sphinx puts into the output." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1285 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1321 msgid "" -"function signature, as a string of the form ``\"(parameter_1, " -"parameter_2)\"``, or ``None`` if introspection didn't succeed and signature " +"function signature, as a string of the form ``'(parameter_1, " +"parameter_2)'``, or ``None`` if introspection didn't succeed and signature " "wasn't specified in the directive." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1288 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1324 msgid "" -"function return annotation as a string of the form ``\" -> annotation\"``, " -"or ``None`` if there is no return annotation" +"function return annotation as a string of the form ``' -> annotation'``, or " +"``None`` if there is no return annotation" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1291 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1327 msgid "" "The :mod:`sphinx.ext.autodoc` module provides factory functions for commonly" " needed docstring processing in event :event:`autodoc-process-docstring`:" @@ -1216,7 +1270,7 @@ msgid "" " be processed." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1299 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1335 msgid "" "Emitted when autodoc has read and processed a class to determine the base-" "classes. *bases* is a list of classes that the event handler can modify " @@ -1224,38 +1278,38 @@ msgid "" "if ``show-inheritance`` option given." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1307 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1343 msgid "the options given to the class directive" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1308 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1344 msgid "the list of base classes signature. see above." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1313 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1349 msgid "" "``bases`` can contain a string as a base class name. It will be processed as" " reStructuredText." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1318 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1354 msgid "Skipping members" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1320 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1356 msgid "" "autodoc allows the user to define a custom method for determining whether a " "member should be included in the documentation by using the following event:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1327 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1363 msgid "" "Emitted when autodoc has to decide whether a member should be included in " "the documentation. The member is excluded if a handler returns ``True``. " "It is included if the handler returns ``False``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1331 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1367 msgid "" "If more than one enabled extension handles the ``autodoc-skip-member`` " "event, autodoc will use the first non-``None`` value returned by a handler. " @@ -1263,7 +1317,7 @@ msgid "" "autodoc and other enabled extensions." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1342 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1378 msgid "" "a boolean indicating if autodoc will skip this member if the user handler " "does not override the decision" diff --git a/locale/zh_CN/LC_MESSAGES/changes/1.8.po b/locale/zh_CN/LC_MESSAGES/changes/1.8.po index d2369d28ea..31298ff9a7 100644 --- a/locale/zh_CN/LC_MESSAGES/changes/1.8.po +++ b/locale/zh_CN/LC_MESSAGES/changes/1.8.po @@ -14,7 +14,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-10-01 00:54+0000\n" +"POT-Creation-Date: 2024-10-03 00:49+0000\n" "PO-Revision-Date: 2024-07-31 00:36+0000\n" "Last-Translator: Izabel Wang , 2024\n" "Language-Team: Chinese (China) (https://app.transifex.com/sphinx-doc/teams/15434/zh_CN/)\n" @@ -409,8 +409,8 @@ msgstr "#5418：Sphinx 内部版本 -d/doctrees 文件的默认路径错误" #: ../../sphinx/doc/changes/1.8.rst:150 msgid "" "#5421: autodoc emits deprecation warning for " -":confval:`autodoc_default_flags`" -msgstr "#5421：autodoc 为 :confval:`autodoc_default_flags` 发出弃用警告" +":confval:`!autodoc_default_flags`" +msgstr "" #: ../../sphinx/doc/changes/1.8.rst:151 msgid "#5422: lambda object causes PicklingError on storing environment" @@ -689,8 +689,8 @@ msgid ":confval:`!source_parsers` is deprecated" msgstr "" #: ../../sphinx/doc/changes/1.8.rst:254 -msgid ":confval:`autodoc_default_flags` is deprecated" -msgstr "不推荐 :confval:`autodoc_default_flags`" +msgid ":confval:`!autodoc_default_flags` is deprecated" +msgstr "" #: ../../sphinx/doc/changes/1.8.rst:255 msgid "quickstart: ``--epub`` option becomes default, so it is deprecated" diff --git a/locale/zh_CN/LC_MESSAGES/changes/index.po b/locale/zh_CN/LC_MESSAGES/changes/index.po index 0e410fd131..2964dfa823 100644 --- a/locale/zh_CN/LC_MESSAGES/changes/index.po +++ b/locale/zh_CN/LC_MESSAGES/changes/index.po @@ -12,7 +12,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-09-28 00:48+0000\n" +"POT-Creation-Date: 2024-10-03 00:49+0000\n" "PO-Revision-Date: 2024-07-31 00:36+0000\n" "Last-Translator: JY3, 2024\n" "Language-Team: Chinese (China) (https://app.transifex.com/sphinx-doc/teams/15434/zh_CN/)\n" @@ -239,11 +239,18 @@ msgid "" ":rst:dir:`py:module` directives. Patch by Stephen Finucane." msgstr "" -#: ../../sphinx/CHANGES.rst:112 +#: ../../sphinx/CHANGES.rst:110 +msgid "" +"#12916: Restore support for custom templates named with the legacy ``_t`` " +"suffix during ``apidoc`` RST rendering (regression in 7.4.0). Patch by James" +" Addison." +msgstr "" + +#: ../../sphinx/CHANGES.rst:115 msgid "Testing" msgstr "测试" -#: ../../sphinx/CHANGES.rst:114 +#: ../../sphinx/CHANGES.rst:117 msgid "" "#12141: Migrate from the deprecated ``karma`` JavaScript test framework to " "the actively-maintained ``jasmine`` framework. Test coverage is unaffected." diff --git a/locale/zh_CN/LC_MESSAGES/extdev/deprecated.po b/locale/zh_CN/LC_MESSAGES/extdev/deprecated.po index d064d26df5..9d10918971 100644 --- a/locale/zh_CN/LC_MESSAGES/extdev/deprecated.po +++ b/locale/zh_CN/LC_MESSAGES/extdev/deprecated.po @@ -14,7 +14,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-09-02 00:47+0000\n" +"POT-Creation-Date: 2024-10-03 00:50+0000\n" "PO-Revision-Date: 2019-03-09 18:04+0000\n" "Last-Translator: Lu , 2023\n" "Language-Team: Chinese (China) (https://app.transifex.com/sphinx-doc/teams/15434/zh_CN/)\n" @@ -2882,8 +2882,8 @@ msgid ":meth:`~sphinx.application.Sphinx.add_js_file`" msgstr "" #: ../../sphinx/doc/extdev/deprecated.rst:1457 -msgid ":confval:`autodoc_default_flags`" -msgstr ":confval:`autodoc_default_flags`" +msgid ":confval:`!autodoc_default_flags`" +msgstr "" #: ../../sphinx/doc/extdev/deprecated.rst:1460 msgid ":confval:`autodoc_default_options`" diff --git a/locale/zh_CN/LC_MESSAGES/usage/domains/restructuredtext.po b/locale/zh_CN/LC_MESSAGES/usage/domains/restructuredtext.po index 71dc8c67af..2525b0a5a6 100644 --- a/locale/zh_CN/LC_MESSAGES/usage/domains/restructuredtext.po +++ b/locale/zh_CN/LC_MESSAGES/usage/domains/restructuredtext.po @@ -12,7 +12,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-09-15 00:53+0000\n" +"POT-Creation-Date: 2024-10-03 00:49+0000\n" "PO-Revision-Date: 2023-10-03 00:37+0000\n" "Last-Translator: Melia Lee , 2023\n" "Language-Team: Chinese (China) (https://app.transifex.com/sphinx-doc/teams/15434/zh_CN/)\n" @@ -80,3 +80,20 @@ msgstr "" #: ../../sphinx/doc/usage/domains/restructuredtext.rst:97 msgid "These roles are provided to refer to the described objects:" msgstr "提供这些角色是为了引用所描述的对象：" + +#: ../../sphinx/doc/usage/domains/restructuredtext.rst:101 +msgid "Reference directives and directive options. Examples:" +msgstr "" + +#: ../../sphinx/doc/usage/domains/restructuredtext.rst:103 +msgid "Use ``:rst:dir:`my-directive``` to reference a directive." +msgstr "" + +#: ../../sphinx/doc/usage/domains/restructuredtext.rst:104 +msgid "" +"Use ``:rst:dir:`my-directive:my-option``` to reference a directive option." +msgstr "" + +#: ../../sphinx/doc/usage/domains/restructuredtext.rst:109 +msgid "Reference a role. Example: ``:rst:role:`my-role```." +msgstr "" diff --git a/locale/zh_CN/LC_MESSAGES/usage/extensions/autodoc.po b/locale/zh_CN/LC_MESSAGES/usage/extensions/autodoc.po index 11695ecc01..bca203964b 100644 --- a/locale/zh_CN/LC_MESSAGES/usage/extensions/autodoc.po +++ b/locale/zh_CN/LC_MESSAGES/usage/extensions/autodoc.po @@ -6,7 +6,6 @@ # Translators: # Georg Brandl , 2018 # Melia Lee , 2020 -# Lu , 2022 # cdarlint , 2024 # wendi cao <651645601@qq.com>, 2024 # @@ -15,7 +14,7 @@ msgid "" msgstr "" "Project-Id-Version: Sphinx 8.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-10-02 00:49+0000\n" +"POT-Creation-Date: 2024-10-03 00:50+0000\n" "PO-Revision-Date: 2018-06-26 15:58+0000\n" "Last-Translator: wendi cao <651645601@qq.com>, 2024\n" "Language-Team: Chinese (China) (https://app.transifex.com/sphinx-doc/teams/15434/zh_CN/)\n" @@ -29,26 +28,26 @@ msgstr "" msgid ":mod:`sphinx.ext.autodoc` -- Include documentation from docstrings" msgstr "：模式：`sphinx.ext.autodoc`--包括来自docstrings的文档" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:12 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:15 msgid "" "This extension can import the modules you are documenting, and pull in " "documentation from docstrings in a semi-automatic way." msgstr "这个插件可以导入正在编写文档的模块，并以半自动的方式从文档字符串中拉入文档。" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:17 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:20 msgid "" ":mod:`~sphinx.ext.autodoc` **imports** the modules to be documented. If any " "modules have side effects on import, these will be executed by ``autodoc`` " "when :program:`sphinx-build` is run." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:21 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:24 msgid "" "If you document scripts (as opposed to library modules), make sure that the " "main routine is protected by an ``if __name__ == '__main__'`` condition." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:25 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:28 msgid "" "For this to work, the docstrings must of course be written in correct " "reStructuredText. You can then use all of the usual Sphinx markup in the " @@ -58,7 +57,7 @@ msgid "" "auto-generated-looking pure API documentation." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:33 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:36 msgid "" "If you prefer `NumPy`_ or `Google`_ style docstrings over reStructuredText, " "you can also enable the :mod:`napoleon ` extension. " @@ -66,25 +65,25 @@ msgid "" "reStructuredText before ``autodoc`` processes them." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:43 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:46 msgid "Getting started" msgstr "开始" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:47 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:50 msgid "Setup" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:49 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:52 msgid "" "Activate the plugin by adding ``'sphinx.ext.autodoc'`` to the " ":confval:`extensions` list in :file:`conf.py`:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:61 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:64 msgid "Ensuring the code can be imported" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:63 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:66 msgid "" ":mod:`~sphinx.ext.autodoc` analyses the code and docstrings by introspection" " after **importing the modules**. For importing to work, you have to make " @@ -94,11 +93,11 @@ msgid "" "fail)." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:70 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:73 msgid "There are two ways to ensure this:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:72 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:75 msgid "" "Use an environment that contains your package and Sphinx. This can e.g. be " "your local development environment (with an editable install), or an " @@ -107,14 +106,14 @@ msgid "" "that all dependencies are available." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:78 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:81 msgid "" "It is alternatively possible to patch the Sphinx run so that it can operate " "directly on the sources; e.g. if you want to be able to do a Sphinx build " "from a source checkout." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:82 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:85 msgid "" "Patch :data:`sys.path` in :file:`conf.py` to include your source path. For " "example if you have a repository structure with :file:`doc/conf.py` and your" @@ -122,17 +121,17 @@ msgid "" "your :file:`conf.py`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:94 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:97 msgid "" "To cope with missing dependencies, specify the missing modules in the " ":confval:`autodoc_mock_imports` setting." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:99 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:102 msgid "Usage" msgstr "如何使用" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:101 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:104 msgid "" "You can now use the :ref:`autodoc-directives` to add formatted documentation" " for Python code elements like functions, classes, modules, etc. For " @@ -140,24 +139,24 @@ msgid "" "docstring from the source file, you'd write:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:110 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:113 msgid "" "You can also document whole classes or even modules automatically, using " "member options for the auto directives, like:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:119 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:122 msgid "" "As a hint to autodoc extension, you can put a ``::`` separator between the " "module name and the object name to let autodoc know the correct module, if " "it is ambiguous:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:129 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:132 msgid "Marking objects as public or private" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:131 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:134 msgid "" "autodoc considers a member private if its docstring contains ``:meta " "private:`` in its :ref:`info-field-lists`. For example:" @@ -165,7 +164,7 @@ msgstr "" "如果某个成员的docstring在其：ref:`info field list`中包含“`:meta " "private:`”，则autodoc将其视为私有成员。例如：" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:145 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:148 msgid "" "autodoc considers a member public if its docstring contains ``:meta " "public:`` in its :ref:`info-field-lists`, even if it starts with an " @@ -174,18 +173,18 @@ msgstr "" "如果某个成员的docstring在其：ref:`info field list`中包含“`:meta " "public:``”，即使它以下划线开头，它也会认为它是公共的。例如：" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:160 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:163 msgid "" "autodoc considers a variable member does not have any default value if its " "docstring contains ``:meta hide-value:`` in its :ref:`info-field-lists`. " "Example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:174 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:177 msgid "Doc comments and docstrings" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:176 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:179 msgid "" "Python has no built-in support for docstrings for module data members or " "class attributes. To allow documenting these, ``autodoc`` recognises a " @@ -193,7 +192,7 @@ msgid "" " 'documentation comment'." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:181 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:184 msgid "" "These comments start with a colon and an optional space character, ``'#:'`` " "or ``'#: '``. To be recognised, the comments must appear either on the same " @@ -202,28 +201,28 @@ msgid "" "definition." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:188 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:191 msgid "" "For example, all three of the following variables have valid doc-comments:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:202 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:205 msgid "" "Alternatively, ``autodoc`` can recognise a docstring on the line immediately" " following the definition." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:205 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:208 msgid "" "In the the following class definition, all attributes have documentation " "recognised by ``autodoc``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:233 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:236 msgid "Directives" msgstr "指令" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:235 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:238 msgid "" ":mod:`autodoc` provides several directives that are versions of the usual " ":rst:dir:`py:module`, :rst:dir:`py:class` and so forth. On parsing time, " @@ -232,24 +231,24 @@ msgid "" ":rst:dir:`py:module`, :rst:dir:`py:class` etc. directive." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:244 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:247 msgid "" "Just as :rst:dir:`py:class` respects the current :rst:dir:`py:module`, " ":rst:dir:`autoclass` will also do so. Likewise, :rst:dir:`automethod` will " "respect the current :rst:dir:`py:class`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:250 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:253 msgid "Default directive options" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:252 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:255 msgid "" "To make any of the options described below the default, use the " ":confval:`autodoc_default_options` dictionary in :file:`conf.py`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:255 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:258 msgid "" "If using defaults for the ``:members:``, ``:exclude-members:``, ``:private-" "members:``, or ``:special-members:`` options, setting the option on a " @@ -258,111 +257,111 @@ msgid "" "(``+``), as follows:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:269 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:272 msgid "" "If using :confval:`autodoc_default_options`, the defaults can be disabled " "per-directive with the negated form, :samp:`:no-{option}:` as an option of " "the directive For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:281 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:284 msgid "Automatically document modules" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:285 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:288 msgid "" "Document a module. By default, the directive only inserts the docstring of " "the module itself:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:292 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:526 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:792 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:866 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:295 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:531 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:797 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:871 msgid "will produce source like this:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:300 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:534 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:303 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:539 msgid "" "The directive can also contain content of its own, which will be inserted " "into the resulting non-auto directive source after the docstring (but before" " any automatic member documentation)." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:304 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:538 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:878 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:307 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:543 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:883 msgid "" "Therefore, you can also mix automatic and non-automatic member " "documentation, as follows:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:317 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:567 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:844 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:894 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:320 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:572 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:849 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:899 msgid "Options" msgstr "选项" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:321 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:324 msgid "" "Do not generate an index entry for the documented module or any auto-" "documented members." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:329 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:332 msgid "" "Indicate platforms on which the module is available. This is identical to " ":rst:dir:`py:module`'s ``:platform:`` option." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:335 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:338 msgid "" "A sentence describing the module's purpose. This is identical to " ":rst:dir:`py:module`'s ``:synopsis:`` option." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:343 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:346 msgid "" "Mark a module as deprecated. This is identical to :rst:dir:`py:module`'s " "``:deprecated:`` option." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:351 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:354 msgid "Do not use ``__all__`` when analysing the module to document." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:356 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:600 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:359 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:605 msgid "Options for selecting members to document" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:360 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:363 msgid "Generate automatic documentation for all members of the target module:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:367 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:370 msgid "" "By default, ``autodoc`` only includes public members with a docstring or " ":ref:`doc-comment ` (``#:``). If ``__all__`` exists, it will be" -" used to define which members are public, unless the ``:ignore-module-all:``" -" option is set." +" used to define which members are public, unless the :rst:dir:`:ignore-" +"module-all: ` option is set." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:372 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:615 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:376 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:620 msgid "" "To only document certain members, an explicit comma-separated list may be " "used as the argument to ``:members:``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:383 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:626 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:387 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:631 msgid "Exclude the given names from the members to document. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:397 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:401 msgid "" "To prevent documentation of imported classes or functions, in an " ":rst:dir:`!automodule` directive with the ``members`` option set, only " @@ -370,198 +369,197 @@ msgid "" "name given to ``automodule`` will be documented." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:402 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:406 msgid "" "Set the ``imported-members`` option if you want to prevent this behavior and" " document all available members." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:405 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:409 msgid "" "Note that attributes from imported modules will not be documented, because " "attribute documentation is discovered by parsing the source file of the " "current module." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:414 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:418 msgid "" "Generate automatic documentation for members of the target module that don't" " have a docstring or doc-comment. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:427 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:431 msgid "" "Generate automatic documentation for private members of the target module. " "This includes names with a leading underscore (e.g. ``_private``) and those " "members explicitly marked as private with ``:meta private:``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:437 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:703 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:441 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:708 msgid "" "To only document certain private members, an explicit comma-separated list " "may be used as the argument to ``:private-members:``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:447 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:475 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:741 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:451 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:479 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:746 msgid "The option can now take a comma-separated list of arguments." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:453 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:457 msgid "" "Generate automatic documentation for special members of the target module, " -"also known as :ref:`\"dunder\" names `. This includes " -"all names enclosed with a double-underscore, e.g. ``__special__``:" +"also known as :ref:`'dunder' names `. This includes all" +" names enclosed with a double-underscore, e.g. ``__special__``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:464 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:730 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:468 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:735 msgid "" "To only document certain special members, an explicit comma-separated list " "may be used as the argument to ``:special-members:``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:479 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:745 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:483 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:750 msgid "Options for documented members" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:483 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:749 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:487 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:754 msgid "" "Choose the ordering of automatically documented members (default: " "``alphabetical``). This overrides the :confval:`autodoc_member_order` " "setting." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:487 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:491 msgid "``alphabetical``: Use simple alphabetical order." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:489 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:493 msgid "" "``groupwise``: Group by object type (class, function, etc), use alphabetical" " order within groups." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:492 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:496 msgid "" "``bysource``: Use the order of objects in the module's source. The " "``__all__`` variable can be used to override this order." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:496 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:762 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:980 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:500 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:767 msgid "" "Note that for source order, the module must be a Python module with the " "source code available." msgstr "请注意，对于源代码顺序，该模块必须是具有可用源代码的Python模块。" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:500 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:766 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:504 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:771 msgid "Support the ``'bysource'`` option." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:506 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:510 msgid "" -"Enable the ``:show-inheritance:`` option for all members of the module, if " -"``:members:`` is enabled." +"Enable the :rst:dir:`:show-inheritance: ` option" +" for all members of the module, if ``:members:`` is enabled." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:513 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:518 msgid "Automatically document classes or exceptions" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:518 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:523 msgid "" -"Document a class. For exception classes, prefer ``autoexception``. By " +"Document a class. For exception classes, prefer ``.. autoexception::``. By " "default, the directive only inserts the docstring of the class itself:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:551 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:828 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:556 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:833 msgid "Advanced usage" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:552 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:829 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:557 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:834 msgid "" "It is possible to override the signature for explicitly documented callable " "objects (functions, methods, classes) with the regular syntax that will " "override the signature gained from introspection:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:562 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:839 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:567 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:844 msgid "" "This is useful if the signature from the method is hidden by a decorator." msgstr "如果方法的签名被修饰符隐藏，这很有用。" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:571 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:898 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:576 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:903 msgid "" "Do not generate an index entry for the documented class or any auto-" "documented members." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:579 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:584 msgid "" "Select which docstring will be used for the main body of the directive. This" " overrides the global value of :confval:`autoclass_content`. The possible " "values are:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:583 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:588 msgid "" "``class``: Only use the class's docstring. The :meth:`!__init__` method can " "be separately documented using the ``:members:`` option or " ":rst:dir:`automethod`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:587 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:592 msgid "``init``: Only use the docstring of the :meth:`!__init__` method." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:589 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:594 msgid "" -"``both`` Use both, appending the docstring of the :meth:`!__init__` method " +"``both``: Use both, appending the docstring of the :meth:`!__init__` method " "to the class's docstring." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:593 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:598 msgid "" "If the :meth:`!__init__` method doesn't exist or has a blank docstring, " "``autodoc`` will attempt to use the :meth:`!__new__` method's docstring, if " "it exists and is not blank." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:604 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:609 msgid "Generate automatic documentation for all members of the target class:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:611 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:616 msgid "" "By default, ``autodoc`` only includes public members with a docstring or " ":ref:`doc-comment ` (``#:``) that are attributes of the target " "class (i.e. not inherited)." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:640 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:645 msgid "" "To generate automatic documentation for members inherited from base classes," " use the ``:inherited-members:`` option:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:649 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:654 msgid "" "This can be combined with the ``:undoc-members:`` option to generate " "automatic documentation for *all* available members of the class." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:652 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:657 msgid "" "The members of classes listed in the argument to ``:inherited-members:`` are" " excluded from the automatic documentation. This defaults to " @@ -570,105 +568,105 @@ msgid "" "as the argument." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:658 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:663 msgid "" "For example; If your class ``MyList`` is derived from ``list`` class and you" " don't want to document ``list.__len__()``, you should specify a option " "``:inherited-members: list`` to avoid special members of list class." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:664 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:669 msgid "" "Should any of the inherited members use a format other than reStructuredText" " for their docstrings, there may be markup warnings or errors." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:670 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:675 msgid "" "``:inherited-members:`` now takes the name of a base class to exclude as an " "argument." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:674 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:679 msgid "A comma separated list of base class names can be used." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:680 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:685 msgid "" "Generate automatic documentation for members of the target class that don't " "have a docstring or doc-comment. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:693 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:698 msgid "" "Generate automatic documentation for private members of the target class. " "This includes names with a leading underscore (e.g. ``_private``) and those " "members explicitly marked as private with ``:meta private:``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:713 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:718 msgid "The option can now take arguments." msgstr "选项现在可以接受参数。" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:719 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:724 msgid "" "Generate automatic documentation for special members of the target class, " -"also known as :ref:`\"dunder\" names `. This includes " -"all names enclosed with a double-underscore, e.g. ``__special__``:" +"also known as :ref:`'dunder' names `. This includes all" +" names enclosed with a double-underscore, e.g. ``__special__``:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:753 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:758 msgid "``'alphabetical'``: Use simple alphabetical order." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:755 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:760 msgid "" "``'groupwise'``: Group by object type (class, function, etc), use " "alphabetical order within groups." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:758 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:763 msgid "" "``'bysource'``: Use the order of objects in the module's source. The " "``__all__`` variable can be used to override this order." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:772 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:777 msgid "Insert the class's base classes after the class signature." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:778 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:783 msgid "Automatically document function-like objects" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:785 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:790 msgid "" "Document a function, method, property, or decorator. By default, the " "directive only inserts the docstring of the function itself:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:800 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:874 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:805 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:879 msgid "" "The directive can also contain content of its own, which will be inserted " "into the resulting non-auto directive source after the docstring." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:804 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:809 msgid "" "Therefore, you can also mix automatic and non-automatic documentation, as " "follows:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:813 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:818 msgid ":rst:dir:`autodecorator`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:815 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:820 msgid ":rst:dir:`autoproperty`." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:820 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:825 msgid "" "If you document decorated functions or methods, keep in mind that " "``autodoc`` retrieves its docstrings by importing the module and inspecting " @@ -677,30 +675,30 @@ msgid "" "the original ``__doc__`` to the new function." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:848 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:853 msgid "Do not generate an index entry for the documented function." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:854 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:859 msgid "Automatically document attributes or data" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:859 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:864 msgid "" "Document a module level variable or constant ('data') or class attribute. By" " default, the directive only inserts the docstring of the variable itself:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:887 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:892 msgid "" ":rst:dir:`autodata` and :rst:dir:`autoattribute` can now extract docstrings." msgstr ":rst:方向：`自动数据`和：rst:方向：`自动属性`现在可以提取文档字符串。" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:890 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:895 msgid "Doc-comments are now allowed on the same line of an assignment." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:908 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:913 msgid "" "By default, ``autodoc`` attempts to obtain the type annotation and value of " "the variable by introspection, displaying it after the variable's name. To " @@ -708,72 +706,78 @@ msgid "" "argument to ``annotation``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:914 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:919 msgid "" "For example, if the runtime value of ``FILE_MODE`` is ``0o755``, the " "displayed value will be ``493`` (as ``oct(493) == '0o755'``). This can be " "fixed by setting ``:annotation: = 0o755``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:918 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:923 msgid "" -"If ``annotation`` is used without arguments, no value or type hint will be " -"shown for the variable." +"If ``:annotation:`` is used without arguments, no value or type hint will be" +" shown for the variable." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:925 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:930 msgid "" -"To display the type hint of the variable without a value, use the ``no-" -"value`` option. If both the ``annotation`` and ``no-value`` options are " -"used, ``no-value`` has no effect." +"To display the type hint of the variable without a value, use the ``:no-" +"value:`` option. If both the ``:annotation:`` and ``:no-value:`` options are" +" used, ``:no-value:`` has no effect." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:932 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:937 msgid "Configuration" msgstr "配置" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:934 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:939 msgid "There are also config values that you can set:" msgstr "您还可以设置配置值：" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:938 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:0 +msgid "Type" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:0 +msgid "Default" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:945 msgid "" "This value selects what content will be inserted into the main body of an " ":rst:dir:`autoclass` directive. The possible values are:" msgstr "此值选择将插入到主体的内容：rst:方向：`自动类`指令。可能的值为：" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:941 -msgid "``\"class\"``" -msgstr "``\"类\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:948 +msgid "``'class'``" +msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:942 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:949 msgid "" -"Only the class' docstring is inserted. This is the default. You can still " -"document ``__init__`` as a separate method using :rst:dir:`automethod` or " -"the ``members`` option to :rst:dir:`autoclass`." +"Only the class' docstring is inserted. You can still document ``__init__`` " +"as a separate method using :rst:dir:`automethod` or the ``members`` option " +"to :rst:dir:`autoclass`." msgstr "" -"只插入类的文档字符串。这是默认值。您仍然可以使用以下方法将“`uuu " -"初始_u2;”作为单独的方法进行文档记录：rst:方向：`自动方法`或``成语那``选项用于：rst:方向：`自动类`。" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:945 -msgid "``\"both\"``" -msgstr "``\"都\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:952 +msgid "``'both'``" +msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:946 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:953 msgid "" "Both the class' and the ``__init__`` method's docstring are concatenated and" " inserted." msgstr "类和方法的文档字符串都被连接并插入。" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:948 -msgid "``\"init\"``" -msgstr "``\"初始化\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:955 +msgid "``'init'``" +msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:949 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:956 msgid "Only the ``__init__`` method's docstring is inserted." msgstr "只插入方法的文档字符串。" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:953 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:960 msgid "" "If the class has no ``__init__`` method or if the ``__init__`` method's " "docstring is empty, but the class has a ``__new__`` method's docstring, it " @@ -781,98 +785,147 @@ msgid "" msgstr "" "如果类没有```unu 初始``方法，或者如果```u 初始_u``方法的文档字符串为空，但该类有一个```unu 新\\`方法的文档字符串，则改用它。" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:961 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:970 msgid "" "This value selects how the signature will be displayed for the class defined" " by :rst:dir:`autoclass` directive. The possible values are:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:964 -msgid "``\"mixed\"``" -msgstr "``\"mixed\"``" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:973 +msgid "``'mixed'``" +msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:965 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:974 msgid "Display the signature with the class name." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:966 -msgid "``\"separated\"``" -msgstr "``\"separated\"``" - -#: ../../sphinx/doc/usage/extensions/autodoc.rst:967 -msgid "Display the signature as a method." +#: ../../sphinx/doc/usage/extensions/autodoc.rst:975 +msgid "``'separated'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:969 -msgid "The default is ``\"mixed\"``." +#: ../../sphinx/doc/usage/extensions/autodoc.rst:976 +msgid "Display the signature as a method." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:975 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:984 msgid "" -"This value selects if automatically documented members are sorted " -"alphabetical (value ``'alphabetical'``), by member type (value " -"``'groupwise'``) or by source order (value ``'bysource'``). The default is " -"alphabetical." -msgstr "此值选择自动记录的成员是按字母顺序排序（值为“字母”），是按成员类型（值为“集团化”）还是按源顺序排序（值为“按源”）。默认值为字母顺序。" +"Define the order in which :rst:dir:`automodule` and :rst:dir:`autoclass` " +"members are listed. Supported values are:" +msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:984 -msgid "Support for ``'bysource'``." -msgstr "支持“bysource”。" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:987 +msgid "``'alphabetical'``: Use alphabetical order." +msgstr "" #: ../../sphinx/doc/usage/extensions/autodoc.rst:989 +msgid "``'groupwise'``: order by member type. The order is:" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:991 +msgid "for modules, exceptions, classes, functions, data" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:992 +msgid "for classes: methods, then properties and attributes" +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:994 +msgid "Members are ordered alphabetically within groups." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:996 msgid "" -"This value is a list of autodoc directive flags that should be automatically" -" applied to all autodoc directives. The supported flags are ``'members'``, " -"``'undoc-members'``, ``'private-members'``, ``'special-members'``, " -"``'inherited-members'``, ``'show-inheritance'``, ``'ignore-module-all'`` and" -" ``'exclude-members'``." +"``'bysource'``: Use the order in which the members appear in the source " +"code. This requires that the module must be a Python module with the source " +"code available." msgstr "" -"此值是自动应用于所有autodoc指令的autodoc指令标志的列表。受支持的标志是“'members'”、“'undoc-" -"members'”、“'private-members'”、“'special-members'”、“'inherited-" -"members'”、“'show-inheritation'”、“'ignore-module-all”和“exclude-members”`。" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:999 -msgid "Integrated into :confval:`autodoc_default_options`." -msgstr "集成到：confval:`autodoc_default_options`。" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1002 +msgid "Support for ``'bysource'``." +msgstr "支持“bysource”。" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1003 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1009 msgid "" "The default options for autodoc directives. They are applied to all autodoc" " directives automatically. It must be a dictionary which maps option names " "to the values. For example:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1017 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1023 msgid "" "Setting ``None`` or ``True`` to the value is equivalent to giving only the " "option name to the directives." msgstr "将“None”或“True”设置为值相当于只给指令指定选项名。" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1020 -msgid "" -"The supported options are ``'members'``, ``'member-order'``, ``'undoc-" -"members'``, ``'private-members'``, ``'special-members'``, ``'inherited-" -"members'``, ``'show-inheritance'``, ``'ignore-module-all'``, ``'imported-" -"members'``, ``'exclude-members'``, ``'class-doc-from'`` and ``'no-value'``." +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1026 +msgid "The supported options are:" msgstr "" #: ../../sphinx/doc/usage/extensions/autodoc.rst:1028 +msgid "``'members'``: See :rst:dir:`automodule:members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1029 +msgid "``'undoc-members'`` See :rst:dir:`automodule:undoc-members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1030 +msgid "``'private-members'``: See :rst:dir:`automodule:private-members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1031 +msgid "``'special-members'``: See :rst:dir:`automodule:special-members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1032 +msgid "``'inherited-members'``: See :rst:dir:`autoclass:inherited-members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1033 +msgid "``'imported-members'``: See :rst:dir:`automodule:imported-members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1034 +msgid "``'exclude-members'``: See :rst:dir:`automodule:exclude-members`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1035 +msgid "``'ignore-module-all'``: See :rst:dir:`automodule:ignore-module-all`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1036 +msgid "``'member-order'``: See :rst:dir:`automodule:member-order`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1037 +msgid "``'show-inheritance'``: See :rst:dir:`autoclass:show-inheritance`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1038 +msgid "``'class-doc-from'``: See :rst:dir:`autoclass:class-doc-from`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1039 +msgid "``'no-value'``: See :rst:dir:`autodata:no-value`." +msgstr "" + +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1043 msgid "Accepts ``True`` as a value." msgstr "接受“True”作为值。" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1031 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1046 msgid "Added ``'imported-members'``." msgstr "添加 ``'imported-members'``." -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1034 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1049 msgid "Added ``'class-doc-from'``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1037 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1052 msgid "Added ``'no-value'``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1042 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1059 msgid "" "Functions imported from C modules cannot be introspected, and therefore the " "signature for such functions cannot be automatically determined. However, " @@ -880,7 +933,7 @@ msgid "" "the function's docstring." msgstr "从C模块导入的函数不能自省，因此不能自动确定这些函数的签名。但是，将签名放入函数的文档字符串的第一行是一个常用的约定。" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1047 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1064 msgid "" "If this boolean value is set to ``True`` (which is the default), autodoc " "will look at the first line of the docstring for functions and methods, and " @@ -889,22 +942,22 @@ msgid "" msgstr "" "如果此布尔值设置为“True”（默认值），自动文档将查看文档字符串的第一行以查找函数和方法，如果它看起来像签名，则使用该行作为签名，并将其从文档字符串内容中删除。" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1052 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1069 msgid "" "autodoc will continue to look for multiple signature lines, stopping at the " "first line that does not look like a signature. This is useful for declaring" " overloaded function signatures." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1059 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1076 msgid "Support overloaded signatures" msgstr "支持重载签名" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1063 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1080 msgid "Overloaded signatures do not need to be separated by a backslash" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1067 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1086 msgid "" "This value contains a list of modules to be mocked up. This is useful when " "some external dependencies are not met at build time and break the building " @@ -912,198 +965,194 @@ msgid "" "themselves and omit the sub-modules:" msgstr "此值包含要模拟的模块列表。当某些外部依赖项在构建时不满足并中断构建过程时，这很有用。只能指定依赖项本身的根包，而忽略子模块：" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1076 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1095 msgid "Will mock all imports under the ``django`` package." msgstr "将模拟“django”包下的所有导入。" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1080 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1099 msgid "" "This config value only requires to declare the top-level modules that should" " be mocked." msgstr "这个配置值只需要声明应该模拟的顶层模块。" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1086 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1107 msgid "" "This value controls how to represent typehints. The setting takes the " "following values:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1089 -msgid "``'signature'`` -- Show typehints in the signature (default)" +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1110 +msgid "``'signature'`` -- Show typehints in the signature" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1090 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1111 msgid "" "``'description'`` -- Show typehints as content of the function or method The" " typehints of overloaded functions or methods will still be represented in " "the signature." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1093 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1114 msgid "``'none'`` -- Do not show typehints" msgstr "``'none'`--不显示类型提示" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1094 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1115 msgid "" "``'both'`` -- Show typehints in the signature and as content of the function" " or method" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1097 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1118 msgid "" "Overloaded functions or methods will not have typehints included in the " "description because it is impossible to accurately represent all possible " "overloads as a list of parameters." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1104 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1125 msgid "New option ``'description'`` is added." msgstr "添加了新选项“description”。" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1108 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1129 msgid "New option ``'both'`` is added." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1112 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1135 msgid "" "This value controls whether the types of undocumented parameters and return " -"values are documented when ``autodoc_typehints`` is set to ``description``." +"values are documented when :confval:`autodoc_typehints` is set to " +"``'description'``. Supported values:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1115 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1140 msgid "" -"The default value is ``\"all\"``, meaning that types are documented for all " -"parameters and return values, whether they are documented or not." +"``'all'``: Types are documented for all parameters and return values, " +"whether they are documented or not." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1118 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1143 msgid "" -"When set to ``\"documented\"``, types will only be documented for a " -"parameter or a return value that is already documented by the docstring." +"``'documented'``: Types will only be documented for a parameter or a return " +"value that is already documented by the docstring." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1121 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1146 msgid "" -"With ``\"documented_params\"``, parameter types will only be annotated if " -"the parameter is documented in the docstring. The return type is always " +"``'documented_params'``: Parameter types will only be annotated if the " +"parameter is documented in the docstring. The return type is always " "annotated (except if it is ``None``)." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1129 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1155 msgid "New option ``'documented_params'`` is added." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1133 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1161 msgid "" "A dictionary for users defined `type aliases`__ that maps a type name to the" " full-qualified object name. It is used to keep type aliases not evaluated " -"in the document. Defaults to empty (``{}``)." +"in the document." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1137 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1165 msgid "" "The type aliases are only available if your program enables :pep:`Postponed " "Evaluation of Annotations (PEP 563) <563>` feature via ``from __future__ " "import annotations``." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1141 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1169 msgid "For example, there is code using a type alias:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1152 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1180 msgid "" "If ``autodoc_type_aliases`` is not set, autodoc will generate internal mark-" "up from this code as following:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1161 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1189 msgid "" "If you set ``autodoc_type_aliases`` as ``{'AliasType': " "'your.module.AliasType'}``, it generates the following document internally:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1176 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1206 msgid "" "This value controls the format of typehints. The setting takes the " "following values:" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1179 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1209 msgid "" "``'fully-qualified'`` -- Show the module name and its name of typehints" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1180 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1210 msgid "" "``'short'`` -- Suppress the leading module names of the typehints (e.g. " -"``io.StringIO`` -> ``StringIO``) (default)" +"``io.StringIO`` -> ``StringIO``)" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1187 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1217 msgid "The default setting was changed to ``'short'``" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1191 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1223 msgid "" "If True, the default argument values of functions will be not evaluated on " "generating document. It preserves them as is in the source code." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1196 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1228 msgid "" "Added as an experimental feature. This will be integrated into autodoc core" " in the future." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1201 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1235 msgid "" "This value controls the behavior of :option:`sphinx-build --fail-on-warning`" " during importing modules. If ``False`` is given, autodoc forcedly " -"suppresses the error if the imported module emits warnings. By default, " -"``True``." +"suppresses the error if the imported module emits warnings." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1206 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1240 msgid "" "This option now has no effect as :option:`!--fail-on-warning` no longer " "exits early." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1212 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1248 msgid "" "This value controls the docstrings inheritance. If set to True the docstring" " for classes or methods, if not explicitly set, is inherited from parents." msgstr "此值控制docstrings继承。如果设置为True，则类或方法的docstring（如果未显式设置）将从父级继承。" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1216 -msgid "The default is ``True``." -msgstr "默认值为真。" - -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1223 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1259 msgid "" -":mod:`autodoc` supports to suppress warning messages via " -":confval:`suppress_warnings`. It allows following warnings types in " -"addition:" -msgstr "：mod:`autodoc`支持通过：confval:`suppress_warnings`来取消警告消息。它还允许以下警告类型：" +":mod:`autodoc` supports suppressing warning messages via " +":confval:`suppress_warnings`. It defines the following additional warnings " +"types:" +msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1227 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1263 msgid "autodoc" msgstr "autodoc" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1228 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1264 msgid "autodoc.import_object" msgstr "autodoc.import_object" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1232 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1268 msgid "Docstring preprocessing" msgstr "文档字符串预处理" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1234 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1270 msgid "autodoc provides the following additional events:" msgstr "自动文档提供如下额外事件" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1240 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1276 msgid "" "Emitted when autodoc has read and processed a docstring. *lines* is a list " "of strings -- the lines of the processed docstring -- that the event handler" @@ -1115,41 +1164,40 @@ msgstr "" msgid "Parameters" msgstr "参数" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1244 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1263 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1275 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1304 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1336 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1280 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1299 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1311 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1340 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1372 msgid "the Sphinx application object" msgstr "sphinx应用目标" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1245 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1276 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1337 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1281 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1312 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1373 msgid "" -"the type of the object which the docstring belongs to (one of " -"``\"module\"``, ``\"class\"``, ``\"exception\"``, ``\"function\"``, " -"``\"method\"``, ``\"attribute\"``)" -msgstr "文档字符串所属对象的类型（“模块”、“类”、“异常”、“函数”、“方法”、“属性”之一）" +"the type of the object which the docstring belongs to (one of ``'module'``, " +"``'class'``, ``'exception'``, ``'function'``, ``'method'``, ``'attribute'``)" +msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1248 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1279 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1305 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1340 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1284 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1315 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1341 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1376 msgid "the fully qualified name of the object" msgstr "对象的完全限定名" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1249 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1264 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1280 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1306 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1341 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1285 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1300 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1316 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1342 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1377 msgid "the object itself" msgstr "对象自身" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1250 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1281 -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1344 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1286 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1317 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1380 msgid "" "the options given to the directive: an object with attributes " "``inherited_members``, ``undoc_members``, ``show_inheritance`` and ``no-" @@ -1157,42 +1205,41 @@ msgid "" "directive" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1254 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1290 msgid "the lines of the docstring, see above" msgstr "文档字符串的行，见上文" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1260 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1296 msgid "" "Emitted before autodoc formats a signature for an object. The event handler " "can modify an object to change its signature." msgstr "在autodoc格式化对象的签名之前发出。事件处理程序可以修改对象以更改其签名。" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1265 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1301 msgid "a boolean indicates an object is bound method or not" msgstr "布尔值表示对象是否是绑定方法" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1271 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1307 msgid "" "Emitted when autodoc has formatted a signature for an object. The event " "handler can return a new tuple ``(signature, return_annotation)`` to change " "what Sphinx puts into the output." msgstr "当自动文档已格式化对象的签名时发出。事件处理程序可以返回一个新的元组`（签名，返回标记）``来更改Sphinx在输出中的内容。" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1285 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1321 msgid "" -"function signature, as a string of the form ``\"(parameter_1, " -"parameter_2)\"``, or ``None`` if introspection didn't succeed and signature " +"function signature, as a string of the form ``'(parameter_1, " +"parameter_2)'``, or ``None`` if introspection didn't succeed and signature " "wasn't specified in the directive." -msgstr "函数签名，如果自省未成功，并且指令中未指定签名，则为格式为“`”（参数_1，参数_2）”``或“无”形式的字符串。" +msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1288 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1324 msgid "" -"function return annotation as a string of the form ``\" -> annotation\"``, " -"or ``None`` if there is no return annotation" +"function return annotation as a string of the form ``' -> annotation'``, or " +"``None`` if there is no return annotation" msgstr "" -"函数return annotation，格式为“—>annotation”`，如果没有return annotation，则返回“None”" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1291 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1327 msgid "" "The :mod:`sphinx.ext.autodoc` module provides factory functions for commonly" " needed docstring processing in event :event:`autodoc-process-docstring`:" @@ -1235,7 +1282,7 @@ msgid "" " be processed." msgstr "如果*what*是字符串序列，则只处理*what*中类型的文档字符串。" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1299 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1335 msgid "" "Emitted when autodoc has read and processed a class to determine the base-" "classes. *bases* is a list of classes that the event handler can modify " @@ -1243,31 +1290,31 @@ msgid "" "if ``show-inheritance`` option given." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1307 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1343 msgid "the options given to the class directive" msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1308 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1344 msgid "the list of base classes signature. see above." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1313 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1349 msgid "" "``bases`` can contain a string as a base class name. It will be processed as" " reStructuredText." msgstr "" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1318 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1354 msgid "Skipping members" msgstr "跳过成员" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1320 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1356 msgid "" "autodoc allows the user to define a custom method for determining whether a " "member should be included in the documentation by using the following event:" msgstr "自动文档允许用户定义一个自定义方法，通过使用以下事件确定是否应将成员包括在文档中：" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1327 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1363 msgid "" "Emitted when autodoc has to decide whether a member should be included in " "the documentation. The member is excluded if a handler returns ``True``. " @@ -1275,7 +1322,7 @@ msgid "" msgstr "" "当自动文档必须决定是否应将成员包含在文档中时发出。如果处理程序返回“True”，则排除该成员。如果处理程序返回“False”，则会包含此函数。" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1331 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1367 msgid "" "If more than one enabled extension handles the ``autodoc-skip-member`` " "event, autodoc will use the first non-``None`` value returned by a handler. " @@ -1284,7 +1331,7 @@ msgid "" msgstr "" "如果多个已启用的扩展处理“自动文档跳过成员r”事件，自动文档将使用处理程序返回的第一个非“None”值。处理程序应返回“None”以返回自动文档和其他已启用扩展的跳过行为。" -#: ../../sphinx/doc/usage/extensions/autodoc.rst:1342 +#: ../../sphinx/doc/usage/extensions/autodoc.rst:1378 msgid "" "a boolean indicating if autodoc will skip this member if the user handler " "does not override the decision" diff --git a/sphinx b/sphinx index 341b0417d5..80c4b65a2a 160000 --- a/sphinx +++ b/sphinx @@ -1 +1 @@ -Subproject commit 341b0417d5ccc2b495276cd60c5c6d8accd2a72c +Subproject commit 80c4b65a2a56271f4800ed4b2bab1fb527d17716