Skip to content

Commit 3a43fab

Browse files
committed
intersphinx, use external in own docs
1 parent 896e8af commit 3a43fab

File tree

3 files changed

+14
-12
lines changed

3 files changed

+14
-12
lines changed

doc/internals/release-process.rst

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -76,29 +76,30 @@ Sphinx 2.x:
7676

7777
* Sphinx 2.x will contain a backwards-compatible replica of the function
7878
which will raise a ``RemovedInSphinx40Warning``.
79-
This is a subclass of :exc:`python:PendingDeprecationWarning`, i.e. it
80-
will not get displayed by default.
79+
This is a subclass of :external+python::exc:`PendingDeprecationWarning`,
80+
i.e., it will not get displayed by default.
8181

8282
* Sphinx 3.x will still contain the backwards-compatible replica, but
8383
``RemovedInSphinx40Warning`` will be a subclass of
84-
:exc:`python:DeprecationWarning` then, and gets displayed by default.
84+
:external+python:exc:`DeprecationWarning` then, and gets displayed by default.
8585

8686
* Sphinx 4.0 will remove the feature outright.
8787

8888
Deprecation warnings
8989
~~~~~~~~~~~~~~~~~~~~
9090

9191
Sphinx will enable its ``RemovedInNextVersionWarning`` warnings by default, if
92-
:envvar:`python:PYTHONWARNINGS` is not set. Therefore you can disable them
93-
using:
92+
:external+python:envvar:`PYTHONWARNINGS` is not set. Therefore you can disable
93+
them using:
9494

9595
* ``PYTHONWARNINGS= make html`` (Linux/Mac)
9696
* ``export PYTHONWARNINGS=`` and do ``make html`` (Linux/Mac)
9797
* ``set PYTHONWARNINGS=`` and do ``make html`` (Windows)
9898

9999
But you can also explicitly enable the pending ones using e.g.
100-
``PYTHONWARNINGS=default`` (see the :ref:`Python docs on configuring warnings
101-
<python:describing-warning-filters>`) for more details.
100+
``PYTHONWARNINGS=default``
101+
(see the :external+python:ref:`Python docs on configuring warnings
102+
<describing-warning-filters>`) for more details.
102103

103104
Release procedures
104105
------------------

doc/tutorial/deploying.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -160,11 +160,11 @@ Read the Docs
160160
~~~~~~~~~~~~~
161161

162162
`Read the Docs`_ offers integration with both GitHub and GitLab. The quickest
163-
way of getting started is to follow :doc:`the RTD
164-
tutorial <readthedocs:tutorial/index>`, which is loosely based on this one.
163+
way of getting started is to follow :external+readthedocs:doc:`the RTD
164+
tutorial <tutorial/index>`, which is loosely based on this one.
165165
You can publish your sources on GitHub as explained :ref:`in the previous
166166
section <publishing-sources>`, then skip directly to
167-
:ref:`readthedocs:tutorial/index:Sign up for Read the Docs`.
167+
:external+readthedocs:ref:`tutorial/index:Sign up for Read the Docs`.
168168
If you choose GitLab instead, the process is similar.
169169

170170
GitHub Pages

doc/usage/configuration.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2664,8 +2664,9 @@ Options for the linkcheck builder
26642664
A regular expression that matches a URI.
26652665
*auth_info*
26662666
Authentication information to use for that URI. The value can be anything
2667-
that is understood by the ``requests`` library (see :ref:`requests
2668-
Authentication <requests:authentication>` for details).
2667+
that is understood by the ``requests`` library
2668+
(see :external+requests:ref:`requests Authentication <authentication>` for
2669+
details).
26692670

26702671
The ``linkcheck`` builder will use the first matching ``auth_info`` value
26712672
it can find in the :confval:`linkcheck_auth` list, so values earlier in the

0 commit comments

Comments
 (0)