[Author Prev][Author Next][Thread Prev][Thread Next][Author Index][Thread Index]
[tor-commits] [ooni-probe/master] Add nettest apidoc
commit c0be39e758b52f797c88bd67782d6cae57838ab2
Author: aagbsn <aagbsn@xxxxxxxx>
Date: Thu Dec 6 19:29:12 2012 +0000
Add nettest apidoc
---
docs/source/api/modules.rst | 7 ---
docs/source/index.rst | 2 +
docs/source/nettests/modules.rst | 8 +++
docs/source/nettests/nettests.blocking.rst | 26 +++++++++++
docs/source/nettests/nettests.examples.rst | 58 ++++++++++++++++++++++++
docs/source/nettests/nettests.experimental.rst | 58 ++++++++++++++++++++++++
docs/source/nettests/nettests.manipulation.rst | 58 ++++++++++++++++++++++++
docs/source/nettests/nettests.scanning.rst | 10 ++++
docs/source/nettests/nettests.third_party.rst | 10 ++++
9 files changed, 230 insertions(+), 7 deletions(-)
diff --git a/docs/source/api/modules.rst b/docs/source/api/modules.rst
deleted file mode 100644
index a9f85c8..0000000
--- a/docs/source/api/modules.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-ooni
-====
-
-.. toctree::
- :maxdepth: 4
-
- ooni
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 1abb517..711440f 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -118,8 +118,10 @@ More developer documentation
.. toctree::
:maxdepth: 2
+ :glob:
oonib
writing_tests
api/*
+ nettests/modules
glossary
diff --git a/docs/source/nettests/modules.rst b/docs/source/nettests/modules.rst
new file mode 100644
index 0000000..408bbad
--- /dev/null
+++ b/docs/source/nettests/modules.rst
@@ -0,0 +1,8 @@
+nettests
+========
+
+.. toctree::
+ :glob:
+ :maxdepth: 2
+
+ *
diff --git a/docs/source/nettests/nettests.blocking.rst b/docs/source/nettests/nettests.blocking.rst
new file mode 100644
index 0000000..03a08b6
--- /dev/null
+++ b/docs/source/nettests/nettests.blocking.rst
@@ -0,0 +1,26 @@
+nettests blocking Package
+=========================
+
+:mod:`nettests.blocking.dnstamper` Module
+-----------------------------------------
+
+.. automodule:: nettests.blocking.dnstamper
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`nettests.blocking.http_requests` Module
+---------------------------------------------
+
+.. automodule:: nettests.blocking.http_requests
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`nettests.blocking.tcpconnect` Module
+------------------------------------------
+
+.. automodule:: nettests.blocking.tcpconnect
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/source/nettests/nettests.examples.rst b/docs/source/nettests/nettests.examples.rst
new file mode 100644
index 0000000..6027455
--- /dev/null
+++ b/docs/source/nettests/nettests.examples.rst
@@ -0,0 +1,58 @@
+nettests examples Package
+=========================
+
+:mod:`nettests.examples.example_dnst` Module
+--------------------------------------------
+
+.. automodule:: nettests.examples.example_dnst
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`nettests.examples.example_http_checksum` Module
+-----------------------------------------------------
+
+.. automodule:: nettests.examples.example_http_checksum
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`nettests.examples.example_httpt` Module
+---------------------------------------------
+
+.. automodule:: nettests.examples.example_httpt
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`nettests.examples.example_myip` Module
+--------------------------------------------
+
+.. automodule:: nettests.examples.example_myip
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`nettests.examples.example_scapyt` Module
+----------------------------------------------
+
+.. automodule:: nettests.examples.example_scapyt
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`nettests.examples.example_scapyt_yield` Module
+----------------------------------------------------
+
+.. automodule:: nettests.examples.example_scapyt_yield
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`nettests.examples.example_tcpt` Module
+--------------------------------------------
+
+.. automodule:: nettests.examples.example_tcpt
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/source/nettests/nettests.experimental.rst b/docs/source/nettests/nettests.experimental.rst
new file mode 100644
index 0000000..110cf14
--- /dev/null
+++ b/docs/source/nettests/nettests.experimental.rst
@@ -0,0 +1,58 @@
+nettests experimental Package
+=============================
+
+:mod:`nettests.experimental.chinatrigger` Module
+------------------------------------------------
+
+.. automodule:: nettests.experimental.chinatrigger
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`nettests.experimental.domclass_collector` Module
+------------------------------------------------------
+
+.. automodule:: nettests.experimental.domclass_collector
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`nettests.experimental.http_keyword_filtering` Module
+----------------------------------------------------------
+
+.. automodule:: nettests.experimental.http_keyword_filtering
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`nettests.experimental.http_uk_mobile_networks` Module
+-----------------------------------------------------------
+
+.. automodule:: nettests.experimental.http_uk_mobile_networks
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`nettests.experimental.keyword_filtering` Module
+-----------------------------------------------------
+
+.. automodule:: nettests.experimental.keyword_filtering
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`nettests.experimental.parasitictraceroute` Module
+-------------------------------------------------------
+
+.. automodule:: nettests.experimental.parasitictraceroute
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`nettests.experimental.squid` Module
+-----------------------------------------
+
+.. automodule:: nettests.experimental.squid
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/source/nettests/nettests.manipulation.rst b/docs/source/nettests/nettests.manipulation.rst
new file mode 100644
index 0000000..c05f7a7
--- /dev/null
+++ b/docs/source/nettests/nettests.manipulation.rst
@@ -0,0 +1,58 @@
+nettests manipulation Package
+=============================
+
+:mod:`nettests.manipulation.captiveportal` Module
+--------------------------------------------------
+
+.. automodule:: nettests.manipulation.captiveportal
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`nettests.manipulation.daphne` Module
+------------------------------------------
+
+.. automodule:: nettests.manipulation.daphne
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`nettests.manipulation.dnsspoof` Module
+--------------------------------------------
+
+.. automodule:: nettests.manipulation.dnsspoof
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`nettests.manipulation.http_header_field_manipulation` Module
+------------------------------------------------------------------
+
+.. automodule:: nettests.manipulation.http_header_field_manipulation
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`nettests.manipulation.http_host` Module
+---------------------------------------------
+
+.. automodule:: nettests.manipulation.http_host
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`nettests.manipulation.http_invalid_request_line` Module
+-------------------------------------------------------------
+
+.. automodule:: nettests.manipulation.http_invalid_request_line
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`nettests.manipulation.traceroute` Module
+----------------------------------------------
+
+.. automodule:: nettests.manipulation.traceroute
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/source/nettests/nettests.scanning.rst b/docs/source/nettests/nettests.scanning.rst
new file mode 100644
index 0000000..8bad39b
--- /dev/null
+++ b/docs/source/nettests/nettests.scanning.rst
@@ -0,0 +1,10 @@
+nettests scanning Package
+=========================
+
+:mod:`nettests.scanning.http_url_list` Module
+---------------------------------------------
+
+.. automodule:: nettests.scanning.http_url_list
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/source/nettests/nettests.third_party.rst b/docs/source/nettests/nettests.third_party.rst
new file mode 100644
index 0000000..6d0e78a
--- /dev/null
+++ b/docs/source/nettests/nettests.third_party.rst
@@ -0,0 +1,10 @@
+nettests third_party Package
+============================
+
+:mod:`nettests.third_party.netalyzr` Module
+-------------------------------------------
+
+.. automodule:: nettests.third_party.netalyzr
+ :members:
+ :undoc-members:
+ :show-inheritance:
_______________________________________________
tor-commits mailing list
tor-commits@xxxxxxxxxxxxxxxxxxxx
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-commits