diff --git a/doc/internals/release-process.rst b/doc/internals/release-process.rst index 4e34debfba9..f30f7692325 100644 --- a/doc/internals/release-process.rst +++ b/doc/internals/release-process.rst @@ -76,12 +76,12 @@ Sphinx 2.x: * Sphinx 2.x will contain a backwards-compatible replica of the function which will raise a ``RemovedInSphinx40Warning``. - This is a subclass of :exc:`python:PendingDeprecationWarning`, i.e. it - will not get displayed by default. + This is a subclass of :external+python::exc:`PendingDeprecationWarning`, + i.e., it will not get displayed by default. * Sphinx 3.x will still contain the backwards-compatible replica, but ``RemovedInSphinx40Warning`` will be a subclass of - :exc:`python:DeprecationWarning` then, and gets displayed by default. + :external+python:exc:`DeprecationWarning` then, and gets displayed by default. * Sphinx 4.0 will remove the feature outright. @@ -89,16 +89,17 @@ Deprecation warnings ~~~~~~~~~~~~~~~~~~~~ Sphinx will enable its ``RemovedInNextVersionWarning`` warnings by default, if -:envvar:`python:PYTHONWARNINGS` is not set. Therefore you can disable them -using: +:external+python:envvar:`PYTHONWARNINGS` is not set. Therefore you can disable +them using: * ``PYTHONWARNINGS= make html`` (Linux/Mac) * ``export PYTHONWARNINGS=`` and do ``make html`` (Linux/Mac) * ``set PYTHONWARNINGS=`` and do ``make html`` (Windows) But you can also explicitly enable the pending ones using e.g. -``PYTHONWARNINGS=default`` (see the :ref:`Python docs on configuring warnings -`) for more details. +``PYTHONWARNINGS=default`` +(see the :external+python:ref:`Python docs on configuring warnings +`) for more details. Release procedures ------------------ diff --git a/doc/tutorial/deploying.rst b/doc/tutorial/deploying.rst index 85fc6643ab5..2f695f2738a 100644 --- a/doc/tutorial/deploying.rst +++ b/doc/tutorial/deploying.rst @@ -160,11 +160,11 @@ Read the Docs ~~~~~~~~~~~~~ `Read the Docs`_ offers integration with both GitHub and GitLab. The quickest -way of getting started is to follow :doc:`the RTD -tutorial `, which is loosely based on this one. +way of getting started is to follow :external+readthedocs:doc:`the RTD +tutorial `, which is loosely based on this one. You can publish your sources on GitHub as explained :ref:`in the previous section `, then skip directly to -:ref:`readthedocs:tutorial/index:Sign up for Read the Docs`. +:external+readthedocs:ref:`tutorial/index:Sign up for Read the Docs`. If you choose GitLab instead, the process is similar. GitHub Pages diff --git a/doc/usage/configuration.rst b/doc/usage/configuration.rst index 737e2282330..d4a8836c598 100644 --- a/doc/usage/configuration.rst +++ b/doc/usage/configuration.rst @@ -2664,8 +2664,9 @@ Options for the linkcheck builder A regular expression that matches a URI. *auth_info* Authentication information to use for that URI. The value can be anything - that is understood by the ``requests`` library (see :ref:`requests - Authentication ` for details). + that is understood by the ``requests`` library + (see :external+requests:ref:`requests Authentication ` for + details). The ``linkcheck`` builder will use the first matching ``auth_info`` value it can find in the :confval:`linkcheck_auth` list, so values earlier in the