Skip to content

Commit 26ba4f0

Browse files
authored
Merge pull request #490 from kurtmckee/update-readme
Document only to run tox
2 parents 293aea2 + fea2661 commit 26ba4f0

File tree

1 file changed

+11
-14
lines changed

1 file changed

+11
-14
lines changed

README.rst

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -29,29 +29,26 @@ The feedparser documentation is available on the web at:
2929

3030
https://feedparser.readthedocs.io/en/latest/
3131

32-
It is also included in its source format, ReST, in the ``docs/`` directory.
33-
To build the documentation you'll need the Sphinx package, which is available at:
34-
35-
https://www.sphinx-doc.org/
36-
37-
You can then build HTML pages using a command similar to:
32+
It can also be built and browsed locally using `tox`_:
3833

3934
.. code-block:: console
4035
41-
$ sphinx-build -b html docs/ fpdocs
36+
$ tox run -e docs
4237
43-
This will produce HTML documentation in the ``fpdocs/`` directory.
38+
This will produce HTML documentation in the ``build/docs/`` directory.
4439

4540

4641
Testing
4742
=======
4843

49-
Feedparser has an extensive test suite, powered by Tox. To run it, type this:
44+
Feedparser has an extensive test suite, powered by `tox`_:
5045

5146
.. code-block:: console
5247
53-
$ python -m venv venv
54-
$ source venv/bin/activate # or "venv\bin\activate.ps1" on Windows
55-
(venv) $ python -m pip install --upgrade pip
56-
(venv) $ python -m pip install tox
57-
(venv) $ tox
48+
$ tox run-parallel
49+
50+
51+
.. Links
52+
.. =====
53+
..
54+
.. _tox: https://tox.wiki/

0 commit comments

Comments
 (0)