mitmproxy/docs/index.rst

.. include:: introduction.rst


..  toctree::
    :hidden:
    :maxdepth: 1

    introduction
    install
    certinstall
    howmitmproxy
    modes

.. toctree::
    :hidden:
    :caption: Tools

    mitmproxy
    mitmdump
    mitmweb
    config

.. toctree::
    :hidden:
    :caption: Protocols

    protocols/http1
    protocols/http2
    protocols/websocket
    protocols/tcpproxy

.. toctree::
    :hidden:
    :caption: Features

    features/anticache
    features/filters
    features/replacements
    features/clientreplay
    features/serverreplay
    features/setheaders
    features/passthrough
    features/proxyauth
    features/reverseproxy
    features/streaming
    features/socksproxy
    features/sticky
    features/upstreamproxy
    features/upstreamcerts

.. toctree::
    :hidden:
    :caption: Transparent Proxying

    transparent
    transparent/linux
    transparent/osx
    transparent/openbsd

.. toctree::
    :hidden:
    :caption: Scripting

    scripting/overview
    scripting/events
    scripting/api


.. toctree::
    :hidden:
    :caption: Tutorials

    tutorials/30second
    tutorials/gamecenter
    tutorials/transparent-dhcp


.. toctree::
    :hidden:
    :caption: Pathod & Pathoc

    pathod/intro
    pathod/language
    pathod/library
    pathod/test


.. toctree::
    :hidden:
    :caption: Development

    dev/contributing
    dev/sslkeylogfile

..  Indices and tables
    ==================

    * :ref:`genindex`
    * :ref:`modindex`
rewrite basic docs for readthedocs 2015-09-04 14:17:55 +00:00			`.. include:: introduction.rst`


			`.. toctree::`
			`:hidden:`
			`:maxdepth: 1`

			`introduction`
			`install`
			`certinstall`
			`howmitmproxy`
			`modes`

			`.. toctree::`
			`:hidden:`
			`:caption: Tools`

			`mitmproxy`
			`mitmdump`
docs: add mitmweb stub 2016-12-20 16:30:35 +00:00			`mitmweb`
docs++ 2015-09-05 18:15:35 +00:00			`config`

docs++: add individual protocol pages 2017-08-17 08:18:05 +00:00			`.. toctree::`
			`:hidden:`
			`:caption: Protocols`

			`protocols/http1`
			`protocols/http2`
			`protocols/websocket`
			`protocols/tcpproxy`

docs++ 2015-09-05 18:15:35 +00:00			`.. toctree::`
			`:hidden:`
			`:caption: Features`

docs++ 2015-09-05 23:37:15 +00:00			`features/anticache`
			`features/filters`
			`features/replacements`
			`features/clientreplay`
docs :tada: 2015-09-06 01:20:58 +00:00			`features/serverreplay`
			`features/setheaders`
			`features/passthrough`
			`features/proxyauth`
			`features/reverseproxy`
update streaming docs 2017-07-04 08:49:49 +00:00			`features/streaming`
docs :tada: 2015-09-06 01:20:58 +00:00			`features/socksproxy`
			`features/sticky`
			`features/upstreamproxy`
docs++ 2015-09-05 23:37:15 +00:00			`features/upstreamcerts`
rewrite basic docs for readthedocs 2015-09-04 14:17:55 +00:00
docs :tada: 2015-09-06 01:20:58 +00:00			`.. toctree::`
			`:hidden:`
			`:caption: Transparent Proxying`

			`transparent`
			`transparent/linux`
			`transparent/osx`
Add transparent proxy support for OpenBSD Add transparent proxy support for OpenBSD with pf divert-to. 2017-02-11 04:16:09 +00:00			`transparent/openbsd`
docs :tada: 2015-09-06 01:20:58 +00:00
rewrite basic docs for readthedocs 2015-09-04 14:17:55 +00:00			`.. toctree::`
			`:hidden:`
			`:caption: Scripting`

docs: cleanups improvements and fighting sphinx - Hide links to internal code listings, and link to github instead - Improve formatting of code/example captions - Fix outdated documentation of command-line options - Complete documentation of all events + improved formatting - tcp_open -> tcp_start, tcp_close -> tcp_end to reduce confusion 2016-10-11 21:57:05 +00:00			`scripting/overview`
			`scripting/events`
			`scripting/api`
rewrite basic docs for readthedocs 2015-09-04 14:17:55 +00:00

			`.. toctree::`
			`:hidden:`
docs :tada: 2015-09-06 01:20:58 +00:00			`:caption: Tutorials`

			`tutorials/30second`
			`tutorials/gamecenter`
			`tutorials/transparent-dhcp`

Migrate pathod docs to Sphinx All the content of the pathod docs are moved into Sphinx. The interactive format has not translated well to static docs, and there's still a lot of rewriting, format fixing, structuring, etc to be done. 2016-06-07 00:55:32 +00:00
			`.. toctree::`
			`:hidden:`
			`:caption: Pathod & Pathoc`

			`pathod/intro`
			`pathod/language`
			`pathod/library`
			`pathod/test`


docs :tada: 2015-09-06 01:20:58 +00:00			`.. toctree::`
			`:hidden:`
add contributing section that redirects to README 2017-01-29 21:10:37 +00:00			`:caption: Development`
rewrite basic docs for readthedocs 2015-09-04 14:17:55 +00:00
add contributing section that redirects to README 2017-01-29 21:10:37 +00:00			`dev/contributing`
docs :tada: 2015-09-06 01:20:58 +00:00			`dev/sslkeylogfile`
rewrite basic docs for readthedocs 2015-09-04 14:17:55 +00:00
			`.. Indices and tables`
			`==================`

			* :ref:`genindex`
			* :ref:`modindex`