1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
|
Welcome to uTidylib's documentation!
====================================
.. automodule:: tidy
.. autofunction:: parse
.. autofunction:: parseString
.. autoclass:: Document
:members:
.. autoclass:: ReportItem
:members:
.. autoexception:: TidyLibError
.. autoexception:: InvalidOptionError
.. autoexception:: OptionArgError
Installing
==========
To use uTidylib, you need to have HTML tidy library installed.
Check <http://www.html-tidy.org/> for instructions how to obtain it.
Once you have installed the library, install uTidylib:
.. code-block:: sh
pip install uTidylib
Contributing
============
You are welcome to contribute on GitHub, we use it for source code management,
issue tracking and patches submission, see <https://github.com/nijel/utidylib>.
Running testsuite
=================
The testsuite can be exececuted using pytest:
.. code-block:: sh
pytest tidy
Building documentation
======================
To build the doc, just run:
.. code-block:: sh
make -C docs html
This requires that you have Sphinx installed.
The API documentation will be built in the :file:`docs/_build/html/` directory.
License
=======
.. include:: ../LICENSE
.. include:: ../CHANGES.rst
History
=======
This is fork of the original uTidylib with permission with original author.
Originally it incorporated patches from Debian and other distributions, now it
also brings compatibility with recent html-tidy versions and works with Python 3.
The original source code is still available at https://github.com/xdissent/utidylib/.
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
|
