Skip to content

Scrapy, a fast high-level web crawling & scraping framework for Python.

Use InterSphinx for links to the pytest and tox documentation

Adrián Chavesfcfcabf1bdf6
diff --git a/docs/conf.py b/docs/conf.py
index 0e0df274c..e37df7e47 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -275,7 +275,9 @@ coverage_ignore_pyobjects = [
# -------------------------------------
intersphinx_mapping = {
+ 'pytest': ('https://docs.pytest.org/en/latest', None),
'python': ('https://docs.python.org/3', None),
'sphinx': ('https://www.sphinx-doc.org/en/master', None),
+ 'tox': ('https://tox.readthedocs.io/en/latest', None),
'twisted': ('https://twistedmatrix.com/documents/current', None),
}
diff --git a/docs/contributing.rst b/docs/contributing.rst
index 68ae2bf3c..81bb50a77 100644
--- a/docs/contributing.rst
+++ b/docs/contributing.rst
@@ -196,14 +196,14 @@ Tests
Tests are implemented using the :doc:`Twisted unit-testing framework
<twisted:core/development/policy/test-standard>`. Running tests requires
-`tox`_.
+:doc:`tox <tox:index>`.
.. _running-tests:
Running tests
-------------
-Make sure you have a recent enough `tox`_ installation:
+Make sure you have a recent enough :doc:`tox <tox:index>` installation:
``tox --version``
@@ -219,26 +219,27 @@ To run a specific test (say ``tests/test_loader.py``) use:
``tox -- tests/test_loader.py``
-To run the tests on a specific tox_ environment, use ``-e <name>`` with an
-environment name from ``tox.ini``. For example, to run the tests with Python
-3.6 use::
+To run the tests on a specific :doc:`tox <tox:index>` environment, use
+``-e <name>`` with an environment name from ``tox.ini``. For example, to run
+the tests with Python 3.6 use::
tox -e py36
-You can also specify a comma-separated list of environmets, and use `tox’s
-parallel mode`_ to run the tests on multiple environments in parallel::
+You can also specify a comma-separated list of environmets, and use :ref:`tox’s
+parallel mode <tox:parallel_mode>` to run the tests on multiple environments in
+parallel::
tox -e py27,py36 -p auto
-To pass command-line options to pytest_, add them after ``--`` in your call to
-tox_. Using ``--`` overrides the default positional arguments defined in
-``tox.ini``, so you must include those default positional arguments
-(``scrapy tests``) after ``--`` as well::
+To pass command-line options to :doc:`pytest <pytest:index>`, add them after
+``--`` in your call to :doc:`tox <tox:index>`. Using ``--`` overrides the
+default positional arguments defined in ``tox.ini``, so you must include those
+default positional arguments (``scrapy tests``) after ``--`` as well::
tox -- scrapy tests -x # stop after first failure
You can also use the `pytest-xdist`_ plugin. For example, to run all tests on
-the Python 3.6 tox_ environment using all your CPU cores::
+the Python 3.6 :doc:`tox <tox:index>` environment using all your CPU cores::
tox -e py36 -- scrapy tests -n auto
@@ -275,7 +276,4 @@ And their unit-tests are in::
.. _open issues: https://github.com/scrapy/scrapy/issues
.. _PEP 257: https://www.python.org/dev/peps/pep-0257/
.. _pull request: https://help.github.com/en/articles/creating-a-pull-request
-.. _pytest: https://docs.pytest.org/en/latest/usage.html
-.. _pytest-xdist: https://docs.pytest.org/en/3.0.0/xdist.html
-.. _tox: https://pypi.python.org/pypi/tox
-.. _tox’s parallel mode: https://tox.readthedocs.io/en/latest/example/basic.html#parallel-mode
+.. _pytest-xdist: https://github.com/pytest-dev/pytest-xdist