Skip to content

Commit

Permalink
Merge pull request #144 from Gallaecio/intersphinx
Browse files Browse the repository at this point in the history
Use intersphinx for links to the tox documentation
  • Loading branch information
kmike committed Nov 14, 2019
2 parents 273d1ed + 373a94f commit a6b4897
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
5 changes: 4 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,10 @@


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


# --- Nitpicking options ------------------------------------------------------
Expand Down
5 changes: 2 additions & 3 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,12 +42,11 @@ Tests
`pytest`_ is the preferred way to run tests. Just run: ``pytest`` from the
root directory to execute tests using the default Python interpreter.

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

.. _tox: http://tox.testrun.org
.. _pytest: https://docs.pytest.org/en/latest/


Expand Down

0 comments on commit a6b4897

Please sign in to comment.