The source for docs is the RST files in doc/.

Author: ldx

doc/examples.rst

@@ -153,19 +153,19 @@ in/out inteface etc is. To print out all rules in the FILTER table::
     >>> print "======================="
 
 As you see in the code snippet above, rules are organized into chains, and
-chains are in tables. You have a fixed set of tables; for IPv4::
+chains are in tables. You have a fixed set of tables; for IPv4:
 
-* FILTER,
-* NAT,
-* MANGLE and
-* RAW.
+* ``FILTER``,
+* ``NAT``,
+* ``MANGLE`` and
+* ``RAW``.
 
-For IPv6 the tables are::
+For IPv6 the tables are:
 
-* FILTER,
-* MANGLE,
-* RAW and
-* SECURITY.
+* ``FILTER``,
+* ``MANGLE``,
+* ``RAW`` and
+* ``SECURITY``.
 
 To access a table::
 
@@ -409,3 +409,13 @@ commit it::
 
 The drawback is that `Table` is a singleton, and if you disable autocommit, it
 will be disabled for all instances of that `Table`.
+
+Known Issues
+============
+
+These issues are mainly caused by complex interaction with upstream's
+Netfilter implementation, and will require quite significant effort to
+fix. Workarounds are available.
+
+- The ``hashlimit`` match requires explicitly setting ``hashlimit_htable_expire``. See `Issue #201 <https://github.com/ldx/python-iptables/issues/201>`_.
+- The ``NOTRACK`` target is problematic; use ``CT --notrack`` instead. See `Issue #204 <https://github.com/ldx/python-iptables/issues/204>`_.

doc/intro.rst

@@ -44,6 +44,14 @@ If you are looking for ``ebtables`` python bindings, check out
    :target: https://travis-ci.org/ldx/python-iptables
    :alt: Build Status
 
+.. image:: https://coveralls.io/repos/ldx/python-iptables/badge.svg?branch=codecoverage
+   :target: https://coveralls.io/r/ldx/python-iptables?branch=codecoverage
+   :alt: Coverage Status
+
+.. image:: https://landscape.io/github/ldx/python-iptables/codecoverage/landscape.svg
+   :target: https://landscape.io/github/ldx/python-iptables/codecoverage
+   :alt: Code Health
+
 .. image:: https://pypip.in/d/python-iptables/badge.png
    :target: https://pypi.python.org/pypi/python-iptables
    :alt: Number of Downloads
@@ -85,7 +93,7 @@ installs into ``/usr/local/lib``.
 
 Now you can run the tests::
 
-    % sudo PATH=$PATH ./test.py
+    % sudo PATH=$PATH python setup.py test
     WARNING: this test will manipulate iptables rules.
     Don't do this on a production machine.
     Would you like to continue? y/n y