Skip to content

Commit

Permalink
Merge pull request #152 from Gallaecio/intersphinx
Browse files Browse the repository at this point in the history
Use InterSphinx to link to the documentation of Pytest and Scrapy
  • Loading branch information
kmike committed Feb 18, 2020
2 parents 49a3e5b + aeb7f8a commit 8207cb0
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 11 deletions.
4 changes: 3 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -250,7 +250,9 @@

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

Expand Down
17 changes: 7 additions & 10 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,16 +39,15 @@ Install
Tests
=====

`pytest`_ is the preferred way to run tests. Just run: ``pytest`` from the
root directory to execute tests using the default Python interpreter.
:doc:`pytest <pytest:index>` is the preferred way to run tests. Just run:
``pytest`` from the root directory to execute tests using the default Python
interpreter.

: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.

.. _pytest: https://docs.pytest.org/en/latest/


Changelog
=========
Expand All @@ -59,12 +58,10 @@ Changelog
History
-------

The code of w3lib was originally part of the `Scrapy framework`_ but was later
stripped out of Scrapy, with the aim of make it more reusable and to provide a
useful library of web functions without depending on Scrapy.

.. _Scrapy framework: http://scrapy.org
.. _NEWS file: https://github.com/scrapy/w3lib/blob/master/NEWS
The code of w3lib was originally part of the :doc:`Scrapy framework
<scrapy:index>` but was later stripped out of Scrapy, with the aim of make it
more reusable and to provide a useful library of web functions without
depending on Scrapy.


Indices and tables
Expand Down

0 comments on commit 8207cb0

Please sign in to comment.