Skip to content

Commit

Permalink
Merge pull request #490 from kurtmckee/update-readme
Browse files Browse the repository at this point in the history
Document only to run tox
  • Loading branch information
kurtmckee authored Dec 8, 2024
2 parents 293aea2 + fea2661 commit 26ba4f0
Showing 1 changed file with 11 additions and 14 deletions.
25 changes: 11 additions & 14 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,29 +29,26 @@ The feedparser documentation is available on the web at:

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

It is also included in its source format, ReST, in the ``docs/`` directory.
To build the documentation you'll need the Sphinx package, which is available at:

https://www.sphinx-doc.org/

You can then build HTML pages using a command similar to:
It can also be built and browsed locally using `tox`_:

.. code-block:: console
$ sphinx-build -b html docs/ fpdocs
$ tox run -e docs
This will produce HTML documentation in the ``fpdocs/`` directory.
This will produce HTML documentation in the ``build/docs/`` directory.


Testing
=======

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

.. code-block:: console
$ python -m venv venv
$ source venv/bin/activate # or "venv\bin\activate.ps1" on Windows
(venv) $ python -m pip install --upgrade pip
(venv) $ python -m pip install tox
(venv) $ tox
$ tox run-parallel
.. Links
.. =====
..
.. _tox: https://tox.wiki/

0 comments on commit 26ba4f0

Please sign in to comment.