Skip to content

Commit

Permalink
intersphinx, use external in own docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jakobandersen committed Jan 22, 2022
1 parent 5dd63cd commit 048af45
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 12 deletions.
15 changes: 8 additions & 7 deletions doc/internals/release-process.rst
Expand Up @@ -76,29 +76,30 @@ 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.

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
<python:describing-warning-filters>`) for more details.
``PYTHONWARNINGS=default``
(see the :external+python:ref:`Python docs on configuring warnings
<describing-warning-filters>`) for more details.

Release procedures
------------------
Expand Down
6 changes: 3 additions & 3 deletions doc/tutorial/deploying.rst
Expand Up @@ -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 <readthedocs:tutorial/index>`, which is loosely based on this one.
way of getting started is to follow :external+readthedocs:doc:`the RTD
tutorial <tutorial/index>`, which is loosely based on this one.
You can publish your sources on GitHub as explained :ref:`in the previous
section <publishing-sources>`, 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
Expand Down
5 changes: 3 additions & 2 deletions doc/usage/configuration.rst
Expand Up @@ -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 <requests:authentication>` for details).
that is understood by the ``requests`` library
(see :external+requests:ref:`requests Authentication <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
Expand Down

0 comments on commit 048af45

Please sign in to comment.