Commit Graph

219 Commits

Author SHA1 Message Date
Aldo Cortesi
e8aca92ef1 docs: remove auto-generated stubs
These are too verbose/low info for these docs. We should include pointers to
where to start reading the code, and perhaps later we can include full
auto-generated API docs separately.
2016-09-30 09:54:35 +10:00
Aldo Cortesi
7998c1ff86 docs: make sidebar headings more legible 2016-09-30 09:34:24 +10:00
Maximilian Hils
d068000f16 fix typo 2016-09-28 17:44:48 -07:00
Ryan Laughlin
e0f9aef89c Update reverse proxy host header docs 2016-09-26 22:30:01 -07:00
smill
2d4e4eafe1 Fixed restructuredText error. 2016-09-15 18:54:55 +00:00
smill
fad6ee6437 Improved the documentation. 2016-09-05 14:19:08 +00:00
smill
fbfedbdc8f Improved error-handling / supplemented documention. 2016-09-04 01:30:27 +00:00
Aldo Cortesi
46143ba004 Merge pull request #1482 from Kriechi/improve-docs
update docs: how mitmproxy works
2016-09-03 09:59:54 +12:00
Thomas Kriechbaumer
823d8a5da8 add docs for websocket_handshake hook 2016-09-01 09:57:36 +02:00
Maximilian Hils
f27028f58e introduce Response.make for simple response creation 2016-08-23 00:17:06 -07:00
Thomas Kriechbaumer
9671fd8d62 update docs: introduction 2016-08-17 05:13:49 +02:00
Thomas Kriechbaumer
709ed0c0be update docs: how mitmproxy works 2016-08-15 13:08:10 +02:00
Maximilian Hils
3aa2d59f62 Update install.rst 2016-08-02 23:20:58 -07:00
Drake Caraker
2fde1d0b53 Update gamecenter.rst
Typo fix: changed plist score value from '0' to '55', aligning with the subsequent explanatory text.
2016-07-16 15:24:56 -07:00
Maximilian Hils
3602fd7a36 Merge remote-tracking branch 'origin/master' into message-body-encoding 2016-07-15 23:17:57 -07:00
Maximilian Hils
7c67faa8da remove script contexts 2016-07-07 23:50:55 -07:00
Maximilian Hils
6032c4f235 message.content -> .raw_content, implement .text
This PR improves our handling of HTTP message body encodings:

- The unaltered message body is now accessible as `.raw_content`
- The "content-encoding"-decoded content (i.e. gzip removed) content
  is not `.content`, as this is what we want in 99% of the cases.
- `.text` now provides the "content-encoding"-decoded and then
  "content-type charset"-decoded message body.
- The decoded values for `.content` and `.text` are cached,
  so that repeated access and `x.text = x.text` is cheap.
- The `decoded()` decorator is now deprecated, as we can now just use
  `.content`. Similarly `HTTPMessage.get_decoded_content()` is
  deprecated.
2016-07-02 01:51:47 -07:00
Maximilian Hils
ac860c6fc0 improve docs, fix #1290 2016-06-29 00:38:11 -07:00
Maximilian Hils
588dad1bc7 minor docs fix 2016-06-26 14:42:12 -07:00
Maximilian Hils
ed05d3f858 Merge pull request #1285 from westurner/patch-1
DOC: install.rst: Installation on Fedora, Ubuntu
2016-06-23 15:44:29 -07:00
BSalita
a77e850b6f Show how to upgrade pip.
Windows install failed due to out of date pip. Show how to upgrade to latest pip.
2016-06-22 14:49:41 +02:00
Wes Turner
514d75cedd DOC: install.rst: Installation on Fedora, Ubuntu 2016-06-21 19:14:13 -05:00
Maximilian Hils
63c6660895 update examples, tests, docs 2016-06-13 18:17:09 -07:00
Aldo Cortesi
728d5caa22 Fold mitmproxy.version and pathod.version into netlib.version 2016-06-12 10:29:12 +12:00
Aldo Cortesi
c421c41307 Remove odict
- Adds default implementations for _kconv and _reduce_values to MultiDict.
Without these, operations fail in really, really non-obvious ways.
- Replace the remaining few instances of ODict

Fixes #1159
2016-06-09 13:28:43 +12:00
Maximilian Hils
b180bfcf35 fix docs 2016-06-06 19:30:45 -07:00
Maximilian Hils
83f8522981 docs: remove option directive
inserting " .. option::" tags create ugly markup, so we just ditch this
entirely and continue using refs.
2016-06-06 19:10:19 -07:00
Maximilian Hils
9a1cc16643 fix MultiView docs 2016-06-06 19:10:19 -07:00
Aldo Cortesi
9b7de5c98f docs: adjust theme override inclusion
https://github.com/rtfd/readthedocs.org/issues/2116
2016-06-07 13:54:40 +12:00
Aldo Cortesi
e037fe05ff 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 12:55:32 +12:00
Maximilian Hils
56b9ec0974 docs++ 2016-05-18 22:50:45 -07:00
Maximilian Hils
d84fc645a7 docs: minor fixes 2016-04-30 15:25:02 -07:00
Maximilian Hils
613a05b5b7 Update certinstall.rst 2016-04-28 15:22:23 -07:00
Maximilian Hils
228197185e Merge branch 'master' of https://github.com/mitmproxy/mitmproxy 2016-04-11 14:14:27 -07:00
Maximilian Hils
14e9b0a0ac docs: better data structure docs 2016-04-11 14:13:48 -07:00
Felix Yan
5dc7b11229 Add installation instructions for Arch Linux (#1079) 2016-04-11 11:47:48 -07:00
Maximilian Hils
7208a7543f docs: fix logo 2016-04-10 00:07:51 -07:00
Matthew Shao
53e15f778d update document for the removal of CONTENT_MISSING 2016-03-26 16:17:55 +08:00
Aldo Cortesi
08f44b9fad Doc tweaks
This patch does the following:

- Fixes all warnings in the doc tree
- Adds a modd + devd conf file that renders HTML and treats doc warnings as
errors. This lets you send warning output to your desktop notifier, and gives
livereload similar to the livehtml entry in the Makefile.
- Some small tweaks

Sphinx currently has a bug that causes unknown options to generate a warning:

https://github.com/sphinx-doc/sphinx/issues/2229

This is fixed in stable, but not yet released. You can update Sphinx to the
latest stable like so:

pip install --upgrade https://github.com/sphinx-doc/sphinx/archive/stable.zip
2016-02-21 11:47:17 +13:00
Aldo Cortesi
92597f82ea Docs and examples to top level 2016-02-18 09:27:08 +13:00
Maximilian Hils
33fa49277a move mitmproxy 2016-02-15 14:58:46 +01:00
Maximilian Hils
8d8ae74102 workaround for RTD issue rtfd/readthedocs.org#152 2016-02-11 00:38:49 +01:00
Maximilian Hils
b0dc44428e fix #823 2016-02-10 19:42:41 +01:00
Maximilian Hils
db719f1673 remove compatible version specifiers 2016-02-05 22:59:24 +01:00
David Weinstein
4be8d148b1 Add SNI ignore docs and have code match it 2016-01-26 13:09:22 -05:00
Michael J. Bazzinotti
e766838a1a Add Inline Script Hooks to TCP mode 2016-01-10 13:05:01 -05:00
Michael J. Bazzinotti
80690b7906 [docs/libmproxy/test] Support single client-side cert file as argument to
--client-certs
2015-12-28 15:20:45 -05:00
Jakub Wilk
c8f9f4c17e docs: fix typos 2015-12-12 11:18:56 +01:00
Maximilian Hils
59d3e9d954 docs++ 2015-11-07 20:43:10 +01:00
David Dworken
96465075f4 Added information on cert pinning (Fixes #689) 2015-11-06 21:23:10 -05:00
Maximilian Hils
c62abd67d2 docs: fix broken graphic 2015-11-02 13:04:35 +01:00
Maximilian Hils
96db5edc5c docs: improve mode flowchart 2015-11-02 11:50:08 +01:00
Maximilian Hils
51a3378290 improve reverse proxy docs 2015-11-02 10:47:14 +01:00
Nick Badger
4537d561c6 Ubuntu install missing libjpeg8-dev, zlib1g-dev
As per https://pillow.readthedocs.org/en/3.0.0/installation.html#linux-installation, to avoid missing install dependencies.
2015-10-22 18:11:06 -07:00
Nick Badger
a6fee43384 Update ubuntu installation to includ libjpeg
Otherwise install fails with error "--enable-jpeg requested but jpeg not found"
2015-10-22 17:38:55 -07:00
Ben Lerner
22191d63ab doc typo fix 2015-10-13 21:09:56 -04:00
Maximilian Hils
1b6ea5caf3 adjust to netlib response changes + docs 2015-09-26 17:41:14 +02:00
Maximilian Hils
b13acd7956 adjust to netlib request changes + docs 2015-09-26 01:23:59 +02:00
Maximilian Hils
bba5ec7144 experimental: run tests using py.tests 2015-09-21 18:31:30 +02:00
Maximilian Hils
774d5b42a2 improve readme 2015-09-16 03:59:22 +02:00
Maximilian Hils
c3ba98b681 docs: update documentedlist, add filter table headers 2015-09-08 15:36:24 +02:00
Maximilian Hils
c4286b15dc docs: minor fixes 2015-09-07 10:52:18 +02:00
Maximilian Hils
31ee4607c8 remove old docs 2015-09-07 10:30:40 +02:00
Maximilian Hils
b4013659a8 docs 🎉 2015-09-06 03:20:58 +02:00
Maximilian Hils
853cd81075 docs++ 2015-09-06 01:37:15 +02:00
Maximilian Hils
23e8260a99 finish tools section 2015-09-05 23:50:37 +02:00
Maximilian Hils
1165e35e1b docs++ 2015-09-05 20:15:35 +02:00
Maximilian Hils
1fb28594ed doc: headers class 2015-09-05 13:27:11 +02:00
Maximilian Hils
74b3b842fe rewrite basic docs for readthedocs 2015-09-04 16:17:55 +02:00