Skip to content

Commit 373a94f

Browse files
committed
Use intersphinx for links to the tox documentation
1 parent 1f3a290 commit 373a94f

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

docs/conf.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -248,7 +248,10 @@
248248

249249

250250
# Example configuration for intersphinx: refer to the Python standard library.
251-
intersphinx_mapping = {'http://docs.python.org/': None}
251+
intersphinx_mapping = {
252+
'python': ('http://docs.python.org/3', None),
253+
'tox': ('https://tox.readthedocs.io/en/latest', None),
254+
}
252255

253256

254257
# --- Nitpicking options ------------------------------------------------------

docs/index.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,12 +42,11 @@ Tests
4242
`pytest`_ is the preferred way to run tests. Just run: ``pytest`` from the
4343
root directory to execute tests using the default Python interpreter.
4444

45-
`tox`_ could be used to run tests for all supported Python versions.
46-
Install it (using 'pip install tox') and then run ``tox`` from
45+
:doc:`tox <tox:index>` could be used to run tests for all supported Python
46+
versions. Install it (using 'pip install tox') and then run ``tox`` from
4747
the root directory - tests will be executed for all available
4848
Python interpreters.
4949

50-
.. _tox: http://tox.testrun.org
5150
.. _pytest: https://docs.pytest.org/en/latest/
5251

5352

0 commit comments

Comments
 (0)