mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
Merge branch '4.x' into texinfo-add-texinfo_emit_document_references
This commit is contained in:
@@ -1005,7 +1005,7 @@ that use Sphinx's HTMLWriter class.
|
||||
to indicate the location of document using `The Canonical Link Relation`_.
|
||||
Default: ``''``.
|
||||
|
||||
.. _The Canonical Link Relation: https://tools.ietf.org/html/rfc6596
|
||||
.. _The Canonical Link Relation: https://datatracker.ietf.org/doc/html/rfc6596
|
||||
|
||||
.. versionadded:: 1.8
|
||||
|
||||
@@ -2686,10 +2686,23 @@ Options for the linkcheck builder
|
||||
doubling the wait time between attempts until it succeeds or exceeds the
|
||||
``linkcheck_rate_limit_timeout``. By default, the timeout is 5 minutes.
|
||||
|
||||
.. _Retry-After: https://tools.ietf.org/html/rfc7231#section-7.1.3
|
||||
.. _Retry-After: https://datatracker.ietf.org/doc/html/rfc7231#section-7.1.3
|
||||
|
||||
.. versionadded:: 3.4
|
||||
|
||||
.. confval:: linkcheck_exclude_documents
|
||||
|
||||
A list of regular expressions that match documents in which Sphinx should
|
||||
not check the validity of links. This can be used for permitting link decay
|
||||
in legacy or historical sections of the documentation.
|
||||
|
||||
Example::
|
||||
|
||||
# ignore all links in documents located in a subfolder named 'legacy'
|
||||
linkcheck_exclude_documents = [r'.*/legacy/.*']
|
||||
|
||||
.. versionadded:: 4.4
|
||||
|
||||
|
||||
Options for the XML builder
|
||||
---------------------------
|
||||
|
||||
@@ -201,6 +201,25 @@ also use these config values:
|
||||
|
||||
.. versionadded:: 2.1
|
||||
|
||||
.. versionchanged:: 4.4
|
||||
|
||||
If ``autosummary_ignore_module_all`` is ``False``, this configuration
|
||||
value is ignored for members listed in ``__all__``.
|
||||
|
||||
.. confval:: autosummary_ignore_module_all
|
||||
|
||||
If ``False`` and a module has the ``__all__`` attribute set, autosummary
|
||||
documents every member listed in ``__all__`` and no others. Default is
|
||||
``True``
|
||||
|
||||
Note that if an imported member is listed in ``__all__``, it will be
|
||||
documented regardless of the value of ``autosummary_imported_members``. To
|
||||
match the behaviour of ``from module import *``, set
|
||||
``autosummary_ignore_module_all`` to False and
|
||||
``autosummary_imported_members`` to True.
|
||||
|
||||
.. versionadded:: 4.4
|
||||
|
||||
.. confval:: autosummary_filename_map
|
||||
|
||||
A dict mapping object names to filenames. This is necessary to avoid
|
||||
|
||||
@@ -200,6 +200,11 @@ Sphinx but is set to automatically include it from a third-party site.
|
||||
|
||||
.. versionadded:: 1.8
|
||||
|
||||
.. versionchanged:: 4.4.1
|
||||
|
||||
Allow to change the loading method (async or defer) of MathJax if "async"
|
||||
or "defer" key is set.
|
||||
|
||||
.. confval:: mathjax3_config
|
||||
|
||||
The configuration options for MathJax v3 (which is used by default).
|
||||
|
||||
Reference in New Issue
Block a user