From 0919e385146d495a65fdb73ad263b40caee5787a Mon Sep 17 00:00:00 2001 From: Maximilian Hils Date: Sun, 29 Jan 2017 22:08:57 +0100 Subject: remove outdated architecture section from docs --- docs/dev/architecture.rst | 14 -------------- docs/index.rst | 1 - docs/schematics/architecture.pdf | Bin 182446 -> 0 bytes docs/schematics/architecture.png | Bin 87365 -> 0 bytes docs/schematics/architecture.vsdx | Bin 60922 -> 0 bytes 5 files changed, 15 deletions(-) delete mode 100644 docs/dev/architecture.rst delete mode 100644 docs/schematics/architecture.pdf delete mode 100644 docs/schematics/architecture.png delete mode 100644 docs/schematics/architecture.vsdx (limited to 'docs') diff --git a/docs/dev/architecture.rst b/docs/dev/architecture.rst deleted file mode 100644 index e7995141..00000000 --- a/docs/dev/architecture.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. _architecture: - -Architecture -============ - -To give you a better understanding of how mitmproxy works, mitmproxy's -high-level architecture is detailed in the following graphic: - -.. image:: ../schematics/architecture.png - -:download:`architecture.pdf <../schematics/architecture.pdf>` - -Please don't refrain from asking any further -questions on the mailing list, the Slack channel or the GitHub issue tracker. diff --git a/docs/index.rst b/docs/index.rst index a40a5f62..63e0bbf5 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -80,7 +80,6 @@ :hidden: :caption: Hacking - dev/architecture dev/testing dev/sslkeylogfile diff --git a/docs/schematics/architecture.pdf b/docs/schematics/architecture.pdf deleted file mode 100644 index 77f5ad58..00000000 Binary files a/docs/schematics/architecture.pdf and /dev/null differ diff --git a/docs/schematics/architecture.png b/docs/schematics/architecture.png deleted file mode 100644 index 67d6c718..00000000 Binary files a/docs/schematics/architecture.png and /dev/null differ diff --git a/docs/schematics/architecture.vsdx b/docs/schematics/architecture.vsdx deleted file mode 100644 index c4ff13d2..00000000 Binary files a/docs/schematics/architecture.vsdx and /dev/null differ -- cgit v1.2.3 From e10fb22f9cf223d75b2a8f5a1656921fd0c2b7a6 Mon Sep 17 00:00:00 2001 From: Maximilian Hils Date: Sun, 29 Jan 2017 22:09:45 +0100 Subject: remove outdated testing section from docs --- docs/dev/testing.rst | 47 ----------------------------------------------- docs/index.rst | 1 - 2 files changed, 48 deletions(-) delete mode 100644 docs/dev/testing.rst (limited to 'docs') diff --git a/docs/dev/testing.rst b/docs/dev/testing.rst deleted file mode 100644 index b86efce1..00000000 --- a/docs/dev/testing.rst +++ /dev/null @@ -1,47 +0,0 @@ -.. _testing: - -Testing -======= - -All the mitmproxy projects strive to maintain 100% code coverage. In general, -patches and pull requests will be declined unless they're accompanied by a -suitable extension to the test suite. - -Our tests are written for the `py.test`_ or nose_ test frameworks. -At the point where you send your pull request, a command like this: - ->>> py.test --cov mitmproxy - -Should give output something like this: - -.. code-block:: none - - > ---------- coverage: platform darwin, python 2.7.2-final-0 -- - > Name Stmts Miss Cover Missing - > ---------------------------------------------------- - > mitmproxy/__init__ 0 0 100% - > mitmproxy/app 4 0 100% - > mitmproxy/cmdline 100 0 100% - > mitmproxy/controller 69 0 100% - > mitmproxy/dump 150 0 100% - > mitmproxy/encoding 39 0 100% - > mitmproxy/flowfilter 201 0 100% - > mitmproxy/flow 891 0 100% - > mitmproxy/proxy 427 0 100% - > mitmproxy/script 27 0 100% - > mitmproxy/utils 133 0 100% - > mitmproxy/version 4 0 100% - > ---------------------------------------------------- - > TOTAL 2045 0 100% - > ---------------------------------------------------- - > Ran 251 tests in 11.864s - - -There are exceptions to the coverage requirement - for instance, much of the -console interface code can't sensibly be unit tested. These portions are -excluded from coverage analysis either in the **.coveragerc** file, or using -**#pragma no-cover** directives. To keep our coverage analysis relevant, we use -these measures as sparingly as possible. - -.. _nose: https://nose.readthedocs.org/en/latest/ -.. _py.test: https://pytest.org/ diff --git a/docs/index.rst b/docs/index.rst index 63e0bbf5..9fcededc 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -80,7 +80,6 @@ :hidden: :caption: Hacking - dev/testing dev/sslkeylogfile .. Indices and tables -- cgit v1.2.3 From edb96f69f52daa53547a90a392dbdd51cdcfa7f5 Mon Sep 17 00:00:00 2001 From: Maximilian Hils Date: Sun, 29 Jan 2017 22:10:37 +0100 Subject: add contributing section that redirects to README --- docs/dev/contributing.rst | 11 +++++++++++ docs/index.rst | 3 ++- docs/install.rst | 4 ++-- 3 files changed, 15 insertions(+), 3 deletions(-) create mode 100644 docs/dev/contributing.rst (limited to 'docs') diff --git a/docs/dev/contributing.rst b/docs/dev/contributing.rst new file mode 100644 index 00000000..8e04c270 --- /dev/null +++ b/docs/dev/contributing.rst @@ -0,0 +1,11 @@ +.. _contributing: + +Contributing +============ + +As an open source project, **mitmproxy** welcomes contributions of all forms. + +Please head over to the README_ to get started! 😃 + + +.. _README: https://github.com/mitmproxy/mitmproxy/blob/master/README.rst \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index 9fcededc..8ba14f54 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -78,8 +78,9 @@ .. toctree:: :hidden: - :caption: Hacking + :caption: Development + dev/contributing dev/sslkeylogfile .. Indices and tables diff --git a/docs/install.rst b/docs/install.rst index 9a2aca0a..b9524897 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -139,11 +139,11 @@ Latest Development Version If you would like to install mitmproxy directly from the master branch on GitHub or would like to get set up to contribute to the project, install the dependencies as you would for a regular installation from source. Then see the -Hacking_ section of the README on GitHub. You can check your system information +project's README_ on GitHub. You can check your system information by running: ``mitmproxy --version`` -.. _Hacking: https://github.com/mitmproxy/mitmproxy/blob/master/README.rst#hacking +.. _README: https://github.com/mitmproxy/mitmproxy/blob/master/README.rst .. _releases: https://github.com/mitmproxy/mitmproxy/releases .. _mitmproxy.org: https://mitmproxy.org/ .. _`Python website`: https://www.python.org/downloads/windows/ -- cgit v1.2.3