Commit Graph

336 Commits

Author SHA1 Message Date
Maximilian Hils
b5d9dcdeee fix docs CI 2021-02-13 12:29:52 +01:00
Maximilian Hils
d2c9efc98f CI: fail when docs fail to build 2021-02-13 12:26:44 +01:00
Maximilian Hils
805aed4f6a docs++ 2021-02-13 00:13:37 +01:00
Maximilian Hils
0ab59e5524 docs++ 2021-02-05 22:04:45 +01:00
Maximilian Hils
51193f1d20 api docs++ 2021-02-05 09:15:54 +01:00
Maximilian Hils
a7d1f32c89 docs: first prototype to link from events to API reference 2021-02-05 09:15:54 +01:00
Maximilian Hils
09beb1aa13 docs: add api reference using pdoc 2021-02-05 09:15:54 +01:00
zivillian
a793a6256a
fix --certs argument (#4412)
the help output claims that --certs is correct
2021-01-24 22:12:16 +01:00
Thomas Kriechbaumer
9e09b58e78
Merge pull request #4399 from mhils/no-dev-scripts
Make development setup instructions more clear
2021-01-24 11:50:49 +01:00
Maximilian Hils
ea624ae6e3
clean doc folder before building, fixes #4405 (#4406) 2021-01-22 01:40:08 +01:00
Maximilian Hils
05a43572c8 make development setup instructions more clear
Our dev.sh/dev.ps1 scripts feel like an unnecessary layer of abstraction.
The revised docs make the install process transparent to experienced users,
and can also be easily reused for other projects (hi, pdoc!).
2021-01-18 13:56:27 +01:00
Maximilian Hils
81f8f06a11 converge on hooks, events, and commands 2021-01-05 22:00:54 +01:00
Maximilian Hils
6c0e4f1cb7 streamline event/hook/command naming conventions 2021-01-05 21:54:44 +01:00
Maximilian Hils
90df4168f8 coverage++ 2021-01-05 21:54:44 +01:00
Maximilian Hils
667cacba3f generate event documentation from source 2021-01-05 21:54:44 +01:00
Maximilian Hils
ca45548289
Merge pull request #4384 from mhils/mitmproxy.exe
mitmproxy.exe 🎉🥳
2021-01-05 08:18:11 +01:00
Maximilian Hils
605961c57f build mitmproxy.exe 🎉 2021-01-05 07:46:53 +01:00
Maximilian Hils
7941e09016 docs: update protocols section 2021-01-01 22:45:05 +01:00
Maximilian Hils
32c73a8d61 split README.rst into README.md and CONTRIBUTING.md 2020-12-13 18:50:43 +01:00
Thomas Kriechbaumer
ff16fbf71e fix docs ci script running locally 2020-11-08 13:17:38 +01:00
Blake Burkhart
21330f511e is_http10 and is_http11 properties to requests 2020-10-13 09:21:15 -05:00
Blake Burkhart
b17857c7ae Send http/1 request and response trailer headers 2020-10-08 20:43:28 -05:00
Thomas Kriechbaumer
0f96324887 docs: update cert usage instructions 2020-10-07 19:08:34 +02:00
Thomas Kriechbaumer
da6b3b415e
Merge pull request #4186 from simon04/patch-1
Update concepts-certificates.md
2020-10-07 18:40:07 +02:00
Alexander Prinzhorn
8ebfc2cb8f
Update concepts-protocols.md
There is support for HTTP/2 trailers since 5.2
2020-09-26 15:49:26 +02:00
Maximilian Hils
5e4bf9ba88 [docs] minor docs improvements 2020-09-07 19:49:41 +02:00
Martin Plattner
b34eec4f7b fix page id and web-ui tests 2020-09-07 18:09:02 +02:00
Martin Plattner
1c087a47dd reorder tools in docs 2020-09-07 16:36:41 +02:00
Martin Plattner
ed918cca87 fix linting error 2020-09-04 18:51:02 +02:00
Martin Plattner
bc47d69df9 add cli recordings and instructions 2020-09-04 18:47:32 +02:00
Martin Plattner
88d43b51bb tweak cli recordings 2020-09-04 18:45:54 +02:00
Martin Plattner
a8b2cc9df6 restructure docs 2020-09-04 16:48:53 +02:00
Martin Plattner
a465d92215 minor content improvements 2020-09-04 15:38:25 +02:00
Martin Plattner
d305c973f5 merge CliDirector and MitmCliDirector 2020-09-04 15:22:04 +02:00
Martin Plattner
129c03e51a integrate feedback 2020-09-04 15:02:58 +02:00
Martin Plattner
2f434f91ff add recorded casts and instructions 2020-09-03 17:56:08 +02:00
Martin Plattner
cf9b001ccb add tutorials to docs 2020-09-03 17:47:52 +02:00
Martin Plattner
b6d52fc8ab add cli recording scripts 2020-09-03 17:44:00 +02:00
Simon Legner
0ac7833032
Update concepts-certificates.md
Add `keytool -importcert` for Java
2020-08-29 14:52:10 +02:00
Maximilian Hils
901a8dd7d4 docs: add favicon 2020-08-27 15:18:03 +02:00
Maximilian Hils
968f9bf05f disable google analytics for docs 2020-08-27 15:07:53 +02:00
Martin Plattner
6e210f1445 fix docs for Map* addons 2020-07-23 19:27:32 +02:00
Maximilian Hils
366014d0a3
Merge pull request #4069 from mplattner/maplocal-addon
MapLocal addon
2020-07-18 14:24:45 +02:00
Martin Plattner
0c8a46253b map local: align ascii figures in docs 2020-07-17 17:54:46 +02:00
Maximilian Hils
f36dcd8915
revise map local docs
provide a short summary at the start (with easy-to-copy examples) and then discuss the nitty-gritty details below.
2020-07-14 15:55:31 +02:00
Martin Plattner
d6293004e0 map local: update docs 2020-07-10 20:51:18 +02:00
sidahmed-malaoui
ef13270ff2
Command that can generates errors in the documentation
In the title _Work-around to redirect traffic originating from the machine itself_, add the flag `-H` to `sudo` command to avoid errors on certain Linux based OS.
2020-07-10 12:43:37 +01:00
Martin Plattner
8942ae88d5 maplocal addon: update docs 2020-07-08 23:53:44 +02:00
Maximilian Hils
96ce21687e blacklist -> blocklist 2020-07-04 12:09:51 +02:00
Maximilian Hils
c60c3dbb75 docs: consistently use backticks for highlighting 2020-07-04 11:29:53 +02:00