File tree 1 file changed +11
-14
lines changed
1 file changed +11
-14
lines changed Original file line number Diff line number Diff line change @@ -29,29 +29,26 @@ The feedparser documentation is available on the web at:
29
29
30
30
https://feedparser.readthedocs.io/en/latest/
31
31
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 `_:
38
33
39
34
.. code-block :: console
40
35
41
- $ sphinx-build -b html docs/ fpdocs
36
+ $ tox run -e docs
42
37
43
- This will produce HTML documentation in the ``fpdocs / `` directory.
38
+ This will produce HTML documentation in the ``build/docs / `` directory.
44
39
45
40
46
41
Testing
47
42
=======
48
43
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 `_ :
50
45
51
46
.. code-block :: console
52
47
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/
You can’t perform that action at this time.
0 commit comments