Aldo Cortesi
982508d30f
All new documentation
...
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.
2018-02-22 18:07:58 +13:00
Maximilian Hils
6e7030fcfb
update stale URL in README
2018-01-15 18:53:57 +01:00
Bas Broek
dc37f7fd00
Add syntax highlighting to Readme
2017-03-29 13:36:51 +02:00
Maximilian Hils
e4cb96f84d
consolidate readme shields
2017-02-11 11:54:59 +01:00
Maximilian Hils
4746ce939f
README: py.test -> pytest
2017-01-30 16:46:22 +01:00
Maximilian Hils
3fe2f9578a
always use 'venv' as virtualenv folder
2017-01-30 00:40:24 +01:00
Maximilian Hils
f570c57006
add contributing section to README, remove autoenv
2017-01-30 00:33:24 +01:00
Maximilian Hils
a384dea62b
rework README dev sections
2017-01-29 23:06:50 +01:00
Sachin Kelkar
38fd88b3d1
Update instructions
2017-01-06 15:33:05 +05:30
Maximilian Hils
843b1e17c9
add mitmweb to README
2016-12-27 20:47:47 +01:00
Aldo Cortesi
c59b34bbb7
README.rst: recommend "tox -e lint" over using flake8 directly
2016-11-03 20:51:22 +13:00
Maximilian Hils
84555a601f
fix README syntax
2016-10-22 17:20:45 -07:00
Aldo Cortesi
8430f857b5
The final piece: netlib -> mitproxy.net
2016-10-20 11:56:38 +13:00
Aldo Cortesi
381ad898ac
Remove mention of pathod.net from README
...
I'm just about to redirect this to mitmproxy.org
2016-10-18 09:06:32 +13:00
Aldo Cortesi
43a83c89e7
python3: update README and setup.py trove classifiers
2016-10-17 18:42:48 +13:00
Aldo Cortesi
8360f70024
First-order conversion to Python3-only
...
- Zap various occurrences of Python2 in docs and scripts
- Remove six from netlib, and some other places where obvious project-wide
search and replace works.
2016-10-17 15:18:47 +13:00
Thomas Kriechbaumer
329909c514
update README about Python support
2016-07-19 10:43:57 +02:00
Maximilian Hils
636cbfd163
Update README.rst
2016-07-09 01:33:56 -07:00
Maximilian Hils
a4fde737b1
fix appveyor
2016-06-28 21:18:01 -07:00
Thomas Kriechbaumer
566736c799
update appveyor with tox
2016-06-27 23:14:32 +02:00
Aldo Cortesi
4576dbf8aa
Minor wording improvements for the README
2016-06-21 20:52:27 +12:00
Thomas Kriechbaumer
56af469b5a
add Discourse to README
2016-06-21 10:03:32 +02:00
Thomas Kriechbaumer
daa31c0fe0
hide codecov.yml
2016-06-16 18:13:03 +02:00
Thomas Kriechbaumer
1575fd3c9e
update README with tox and flake8 info
2016-06-16 10:12:22 +02:00
Maximilian Hils
e7ba89a327
Update README.rst
2016-06-07 00:32:29 -07:00
Aldo Cortesi
7191906ba8
Merge pull request #1192 from cortesi/testsuite
...
WIP: Solidify pathod test suite
2016-06-03 14:08:48 +12:00
Maximilian Hils
734ec94554
slightly improve readme wording
2016-06-02 18:25:56 -07:00
Aldo Cortesi
c6d15904f3
Merge remote-tracking branch 'upstream/master' into testsuite
2016-06-03 10:19:22 +12:00
Sachin Kelkar
2ca066b7d6
Update README
2016-06-02 23:27:26 +05:30
Aldo Cortesi
14d6e1d2e3
Formatting of README
...
This is really a pretext to get Travis to rebuild, because it's stuck on the
wrong commit for the branch.
2016-06-02 16:43:46 +12:00
Aldo Cortesi
3206a48ceb
Remove downloads for now
...
Fixes #1185
2016-06-01 17:07:15 +12:00
Aldo Cortesi
ebeda5e8d2
It's text markup language, Jim, but not as we know it
2016-06-01 10:17:10 +12:00
Aldo Cortesi
0670354203
Style guides in README
2016-06-01 09:55:43 +12:00
Brett Randall
69adcce566
README.rst should refer to ./dev.sh not ./dev
2016-05-01 22:26:44 +10:00
Maximilian Hils
4a62da6bac
update README
2016-04-09 20:14:42 -07:00
Maximilian Hils
3cbacf4e0b
remove nonmeaningful contributing section from the readme
2016-02-18 11:42:55 +01:00
Thomas Kriechbaumer
09abd7eb9a
add issue template
2016-02-17 21:10:48 +01:00
Thomas Kriechbaumer
b87797ea25
remove test/ from py.test commands
2016-02-16 22:15:10 +01:00
Thomas Kriechbaumer
e2ca4ea923
fix minor things
2016-02-16 22:01:50 +01:00
Maximilian Hils
f864266ccc
update shield.io badges
2016-02-15 23:05:30 +01:00
Maximilian Hils
3d9a5157e7
use own shields instance, update pathod readme
2016-02-15 21:13:06 +01:00
Maximilian Hils
a78c6f1cb0
update README.rst, minor fixes
2016-02-15 19:43:55 +01:00
Maximilian Hils
33fa49277a
move mitmproxy
2016-02-15 14:58:46 +01:00
Morton Fox
be4a1711da
Update virtualenv links
2016-02-12 00:11:01 -05:00
Maximilian Hils
bba5ec7144
experimental: run tests using py.tests
2015-09-21 18:31:30 +02:00
Maximilian Hils
fde2420e37
fix #778
2015-09-19 11:18:57 +02:00
Maximilian Hils
ee6969c1fa
s/below/above/
2015-09-16 13:40:50 +02:00
Maximilian Hils
1f3844da89
make pypi happy
2015-09-16 04:08:29 +02:00
Maximilian Hils
774d5b42a2
improve readme
2015-09-16 03:59:22 +02:00
