[Author Prev][Author Next][Thread Prev][Thread Next][Author Index][Thread Index]

[tor-commits] [ooni-probe/master] Update docs

To: tor-commits@xxxxxxxxxxxxxxxxxxxx
Subject: [tor-commits] [ooni-probe/master] Update docs
From: art@xxxxxxxxxxxxxx
Date: Sat, 2 May 2015 13:32:54 +0000 (UTC)
Delivered-to: archiver@xxxxxxxx
Delivery-date: Sat, 02 May 2015 09:40:42 -0400
List-archive: <http://lists.torproject.org/pipermail/tor-commits/>
List-help: <mailto:tor-commits-request@lists.torproject.org?subject=help>
List-id: "auto: code repository commits" <tor-commits.lists.torproject.org>
List-post: <mailto:tor-commits@lists.torproject.org>
List-subscribe: <https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-commits>, <mailto:tor-commits-request@lists.torproject.org?subject=subscribe>
List-unsubscribe: <https://lists.torproject.org/cgi-bin/mailman/options/tor-commits>, <mailto:tor-commits-request@lists.torproject.org?subject=unsubscribe>
Patch-author: Arturo Filastò <art@xxxxxxxxx>
Sender: "tor-commits" <tor-commits-bounces@xxxxxxxxxxxxxxxxxxxx>

commit ee119a4d6f8a20e169ecc91d9f07d59a5a6a2a40
Author: Arturo FilastÃ² <art@xxxxxxxxx>
Date:   Sat May 2 13:12:58 2015 +0200

    Update docs
---
 docs/source/index.rst                              |    1 +
 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 ----
 docs/source/nettests/ooni.nettests.blocking.rst    |   26 +++++++++
 docs/source/nettests/ooni.nettests.examples.rst    |   58 ++++++++++++++++++++
 .../source/nettests/ooni.nettests.experimental.rst |   58 ++++++++++++++++++++
 .../source/nettests/ooni.nettests.manipulation.rst |   58 ++++++++++++++++++++
 docs/source/nettests/ooni.nettests.scanning.rst    |   10 ++++
 docs/source/nettests/ooni.nettests.third_party.rst |   10 ++++
 docs/source/writing_http_tests.rst                 |   11 ++++
 14 files changed, 232 insertions(+), 220 deletions(-)

diff --git a/docs/source/index.rst b/docs/source/index.rst
index 5dfa05d..53d5b44 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -349,6 +349,7 @@ More developer documentation
     architecture
     oonib
     reports
+    tutorial
     writing_tests
     api/*
     nettests/modules
diff --git a/docs/source/nettests/nettests.blocking.rst b/docs/source/nettests/nettests.blocking.rst
deleted file mode 100644
index eaec0e8..0000000
--- a/docs/source/nettests/nettests.blocking.rst
+++ /dev/null
@@ -1,26 +0,0 @@
-nettests blocking Package
-=========================
-
-:mod:`nettests.blocking.dnsconsistency` Module
------------------------------------------
-
-.. automodule:: nettests.blocking.dnsconsistency
-     :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
deleted file mode 100644
index 6027455..0000000
--- a/docs/source/nettests/nettests.examples.rst
+++ /dev/null
@@ -1,58 +0,0 @@
-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
deleted file mode 100644
index 110cf14..0000000
--- a/docs/source/nettests/nettests.experimental.rst
+++ /dev/null
@@ -1,58 +0,0 @@
-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
deleted file mode 100644
index c05f7a7..0000000
--- a/docs/source/nettests/nettests.manipulation.rst
+++ /dev/null
@@ -1,58 +0,0 @@
-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
deleted file mode 100644
index 8bad39b..0000000
--- a/docs/source/nettests/nettests.scanning.rst
+++ /dev/null
@@ -1,10 +0,0 @@
-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
deleted file mode 100644
index 6d0e78a..0000000
--- a/docs/source/nettests/nettests.third_party.rst
+++ /dev/null
@@ -1,10 +0,0 @@
-nettests third_party Package
-============================
-
-:mod:`nettests.third_party.netalyzr` Module
--------------------------------------------
-
-.. automodule:: nettests.third_party.netalyzr
-     :members:
-     :undoc-members:
-     :show-inheritance:
diff --git a/docs/source/nettests/ooni.nettests.blocking.rst b/docs/source/nettests/ooni.nettests.blocking.rst
new file mode 100644
index 0000000..1dc0e15
--- /dev/null
+++ b/docs/source/nettests/ooni.nettests.blocking.rst
@@ -0,0 +1,26 @@
+ooni.nettests blocking Package
+=========================
+
+:mod:`ooni.nettests.blocking.dnsconsistency` Module
+-----------------------------------------
+
+.. automodule:: ooni.nettests.blocking.dnsconsistency
+     :members:
+     :undoc-members:
+     :show-inheritance:
+
+:mod:`ooni.nettests.blocking.http_requests` Module
+---------------------------------------------
+
+.. automodule:: ooni.nettests.blocking.http_requests
+     :members:
+     :undoc-members:
+     :show-inheritance:
+
+:mod:`ooni.nettests.blocking.tcpconnect` Module
+------------------------------------------
+
+.. automodule:: ooni.nettests.blocking.tcpconnect
+     :members:
+     :undoc-members:
+     :show-inheritance:
diff --git a/docs/source/nettests/ooni.nettests.examples.rst b/docs/source/nettests/ooni.nettests.examples.rst
new file mode 100644
index 0000000..4af11a7
--- /dev/null
+++ b/docs/source/nettests/ooni.nettests.examples.rst
@@ -0,0 +1,58 @@
+ooni.nettests examples Package
+=========================
+
+:mod:`ooni.nettests.examples.example_dnst` Module
+--------------------------------------------
+
+.. automodule:: ooni.nettests.examples.example_dnst
+     :members:
+     :undoc-members:
+     :show-inheritance:
+
+:mod:`ooni.nettests.examples.example_http_checksum` Module
+-----------------------------------------------------
+
+.. automodule:: ooni.nettests.examples.example_http_checksum
+     :members:
+     :undoc-members:
+     :show-inheritance:
+
+:mod:`ooni.nettests.examples.example_httpt` Module
+---------------------------------------------
+
+.. automodule:: ooni.nettests.examples.example_httpt
+     :members:
+     :undoc-members:
+     :show-inheritance:
+
+:mod:`ooni.nettests.examples.example_myip` Module
+--------------------------------------------
+
+.. automodule:: ooni.nettests.examples.example_myip
+     :members:
+     :undoc-members:
+     :show-inheritance:
+
+:mod:`ooni.nettests.examples.example_scapyt` Module
+----------------------------------------------
+
+.. automodule:: ooni.nettests.examples.example_scapyt
+     :members:
+     :undoc-members:
+     :show-inheritance:
+
+:mod:`ooni.nettests.examples.example_scapyt_yield` Module
+----------------------------------------------------
+
+.. automodule:: ooni.nettests.examples.example_scapyt_yield
+     :members:
+     :undoc-members:
+     :show-inheritance:
+
+:mod:`ooni.nettests.examples.example_tcpt` Module
+--------------------------------------------
+
+.. automodule:: ooni.nettests.examples.example_tcpt
+     :members:
+     :undoc-members:
+     :show-inheritance:
diff --git a/docs/source/nettests/ooni.nettests.experimental.rst b/docs/source/nettests/ooni.nettests.experimental.rst
new file mode 100644
index 0000000..4ae67e2
--- /dev/null
+++ b/docs/source/nettests/ooni.nettests.experimental.rst
@@ -0,0 +1,58 @@
+ooni.nettests experimental Package
+=============================
+
+:mod:`ooni.nettests.experimental.chinatrigger` Module
+------------------------------------------------
+
+.. automodule:: ooni.nettests.experimental.chinatrigger
+     :members:
+     :undoc-members:
+     :show-inheritance:
+
+:mod:`ooni.nettests.experimental.domclass_collector` Module
+------------------------------------------------------
+
+.. automodule:: ooni.nettests.experimental.domclass_collector
+     :members:
+     :undoc-members:
+     :show-inheritance:
+
+:mod:`ooni.nettests.experimental.http_keyword_filtering` Module
+----------------------------------------------------------
+
+.. automodule:: ooni.nettests.experimental.http_keyword_filtering
+     :members:
+     :undoc-members:
+     :show-inheritance:
+
+:mod:`ooni.nettests.experimental.http_uk_mobile_networks` Module
+-----------------------------------------------------------
+
+.. automodule:: ooni.nettests.experimental.http_uk_mobile_networks
+     :members:
+     :undoc-members:
+     :show-inheritance:
+
+:mod:`ooni.nettests.experimental.keyword_filtering` Module
+-----------------------------------------------------
+
+.. automodule:: ooni.nettests.experimental.keyword_filtering
+     :members:
+     :undoc-members:
+     :show-inheritance:
+
+:mod:`ooni.nettests.experimental.parasitictraceroute` Module
+-------------------------------------------------------
+
+.. automodule:: ooni.nettests.experimental.parasitictraceroute
+     :members:
+     :undoc-members:
+     :show-inheritance:
+
+:mod:`ooni.nettests.experimental.squid` Module
+-----------------------------------------
+
+.. automodule:: ooni.nettests.experimental.squid
+     :members:
+     :undoc-members:
+     :show-inheritance:
diff --git a/docs/source/nettests/ooni.nettests.manipulation.rst b/docs/source/nettests/ooni.nettests.manipulation.rst
new file mode 100644
index 0000000..cde0283
--- /dev/null
+++ b/docs/source/nettests/ooni.nettests.manipulation.rst
@@ -0,0 +1,58 @@
+ooni.nettests manipulation Package
+=============================
+
+:mod:`ooni.nettests.manipulation.captiveportal` Module
+--------------------------------------------------
+
+.. automodule:: ooni.nettests.manipulation.captiveportal
+     :members:
+     :undoc-members:
+     :show-inheritance:
+
+:mod:`ooni.nettests.manipulation.daphne` Module
+------------------------------------------
+
+.. automodule:: ooni.nettests.manipulation.daphne
+     :members:
+     :undoc-members:
+     :show-inheritance:
+
+:mod:`ooni.nettests.manipulation.dnsspoof` Module
+--------------------------------------------
+
+.. automodule:: ooni.nettests.manipulation.dnsspoof
+     :members:
+     :undoc-members:
+     :show-inheritance:
+
+:mod:`ooni.nettests.manipulation.http_header_field_manipulation` Module
+------------------------------------------------------------------
+
+.. automodule:: ooni.nettests.manipulation.http_header_field_manipulation
+     :members:
+     :undoc-members:
+     :show-inheritance:
+
+:mod:`ooni.nettests.manipulation.http_host` Module
+---------------------------------------------
+
+.. automodule:: ooni.nettests.manipulation.http_host
+     :members:
+     :undoc-members:
+     :show-inheritance:
+
+:mod:`ooni.nettests.manipulation.http_invalid_request_line` Module
+-------------------------------------------------------------
+
+.. automodule:: ooni.nettests.manipulation.http_invalid_request_line
+     :members:
+     :undoc-members:
+     :show-inheritance:
+
+:mod:`ooni.nettests.manipulation.traceroute` Module
+----------------------------------------------
+
+.. automodule:: ooni.nettests.manipulation.traceroute
+     :members:
+     :undoc-members:
+     :show-inheritance:
diff --git a/docs/source/nettests/ooni.nettests.scanning.rst b/docs/source/nettests/ooni.nettests.scanning.rst
new file mode 100644
index 0000000..b4a9da6
--- /dev/null
+++ b/docs/source/nettests/ooni.nettests.scanning.rst
@@ -0,0 +1,10 @@
+ooni.nettests scanning Package
+=========================
+
+:mod:`ooni.nettests.scanning.http_url_list` Module
+---------------------------------------------
+
+.. automodule:: ooni.nettests.scanning.http_url_list
+     :members:
+     :undoc-members:
+     :show-inheritance:
diff --git a/docs/source/nettests/ooni.nettests.third_party.rst b/docs/source/nettests/ooni.nettests.third_party.rst
new file mode 100644
index 0000000..c374ca0
--- /dev/null
+++ b/docs/source/nettests/ooni.nettests.third_party.rst
@@ -0,0 +1,10 @@
+ooni.nettests third_party Package
+============================
+
+:mod:`ooni.nettests.third_party.netalyzr` Module
+-------------------------------------------
+
+.. automodule:: ooni.nettests.third_party.netalyzr
+     :members:
+     :undoc-members:
+     :show-inheritance:
diff --git a/docs/source/writing_http_tests.rst b/docs/source/writing_http_tests.rst
new file mode 100644
index 0000000..4cdd3f7
--- /dev/null
+++ b/docs/source/writing_http_tests.rst
@@ -0,0 +1,11 @@
+.. code:: python
+
+  class HTTPRequest(httpt.HTTPTest):
+      def test_send_headers(self):
+          r = yield self.request.get("http://ooni.nu/";,
+                                     headers={'Foo': 'bar'})
+          print r.headers
+          print r.status_code
+
+          print r.text
+          print r.content

_______________________________________________
tor-commits mailing list
tor-commits@xxxxxxxxxxxxxxxxxxxx
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-commits

Prev by Author: [tor-commits] [ooni-probe/master] Fix underlines
Next by Author: [tor-commits] [ooni-probe/master] Update README to mention the requirements explicitly
Previous by thread: [tor-commits] [ooni-probe/master] Fix underlines
Next by thread: [tor-commits] [ooni-probe/master] Update docs
Index(es):
- Author
- Thread