aboutsummaryrefslogtreecommitdiffstats
path: root/docs/index.rst
Commit message (Collapse)AuthorAgeFilesLines
* All new documentationAldo Cortesi2018-02-221-99/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | This patch does a lot. - Ditch sphinx in favor of hugo. This gives us complete control of the layout and presentation of our docs. Henceforth, docs will be hosted on our website rather than ReadTheDocs. - Create a simple, clean doc layout and theme. - Remove large parts of the documentaion. I've ditched anything that was a) woefully out of date, b) too detailed, or c) too hard to maintain in the long term. - Huge updates to the docs themselves: completely rewrite addons documentation, add docs for core concepts like commands and options, and revise and tweak a lot of the existing docs. With this patch, we're also changing the way we publish and maintain the docs. From now on, we don't publish docs for every release. Instead, the website will contain ONE set of docs for each major release. The online docs will be updated if needed as minor releases are made. Docs are free to improve during minor releases, but anything that changes behaviour sufficiently to require a doc change warrants a new major release. This also leaves us free to progressively update and improve docs out of step with our release cadence. With this new scheme, I feel CI over the docs is less important. I've removed it for now, but won't object if someone wants to add it back in.
* docs++: add individual protocol pagesThomas Kriechbaumer2017-12-121-1/+9
|
* update streaming docsUjjwal Verma2017-07-041-1/+1
|
* Add transparent proxy support for OpenBSDJihyun Yu2017-02-111-0/+1
| | | | Add transparent proxy support for OpenBSD with pf divert-to.
* add contributing section that redirects to READMEMaximilian Hils2017-01-291-1/+2
|
* remove outdated testing section from docsMaximilian Hils2017-01-291-1/+0
|
* remove outdated architecture section from docsMaximilian Hils2017-01-291-1/+0
|
* docs: add mitmweb stubMaximilian Hils2016-12-201-0/+1
|
* docs: logging and the contextAldo Cortesi2016-10-161-1/+0
|
* docs: cleanups improvements and fighting sphinxAldo Cortesi2016-10-161-3/+4
| | | | | | | | - 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
* docs: remove auto-generated stubsAldo Cortesi2016-09-301-3/+0
| | | | | | 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.
* Migrate pathod docs to SphinxAldo Cortesi2016-06-071-1/+11
| | | | | | 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.
* docs: better data structure docsMaximilian Hils2016-04-111-1/+1
|
* Docs and examples to top levelAldo Cortesi2016-02-181-0/+83
|
* move mitmproxyMaximilian Hils2016-02-151-83/+0
|
* docs :tada:Maximilian Hils2015-09-061-1/+30
|
* docs++Maximilian Hils2015-09-061-1/+5
|
* docs++Maximilian Hils2015-09-051-0/+7
|
* rewrite basic docs for readthedocsMaximilian Hils2015-09-041-0/+43