From 84555a601fc7a5ec5f283ff535166862a41ed396 Mon Sep 17 00:00:00 2001 From: Maximilian Hils Date: Sat, 22 Oct 2016 17:20:45 -0700 Subject: [PATCH 1/2] fix README syntax --- README.rst | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index cdeada2d8..33304b70e 100644 --- a/README.rst +++ b/README.rst @@ -43,7 +43,7 @@ Join our developer chat on Slack if you would like to hack on mitmproxy itself. Installation ------------ -The installation instructions are `here `_. +The installation instructions are `here `__. If you want to contribute changes, keep on reading. @@ -52,7 +52,7 @@ Hacking To get started hacking on mitmproxy, make sure you have Python_ 3.5.x or above with virtualenv_ installed (you can find installation instructions for virtualenv -`here `_). Then do the following: +`here `__). Then do the following: .. code-block:: text @@ -188,6 +188,5 @@ PR checks will fail and block merging. We are using this command to check for st .. _.env: https://github.com/mitmproxy/mitmproxy/blob/master/.env .. _Sphinx: http://sphinx-doc.org/ .. _sphinx-autobuild: https://pypi.python.org/pypi/sphinx-autobuild -.. _issue_tracker: https://github.com/mitmproxy/mitmproxy/issues .. _PEP8: https://www.python.org/dev/peps/pep-0008 .. _Google Style Guide: https://google.github.io/styleguide/pyguide.html From 909ecd040a3741e598b52e3b8ac1928e2b9dad37 Mon Sep 17 00:00:00 2001 From: Maximilian Hils Date: Sat, 22 Oct 2016 17:20:57 -0700 Subject: [PATCH 2/2] add README.rst validation to CI --- tox.ini | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/tox.ini b/tox.ini index ff1484d0e..0b183da8b 100644 --- a/tox.ini +++ b/tox.ini @@ -18,5 +18,9 @@ changedir = docs commands = sphinx-build -W -b html -d {envtmpdir}/doctrees . {envtmpdir}/html [testenv:lint] -deps = flake8>=2.6.2, <3.1 -commands = flake8 --jobs 8 --count mitmproxy pathod examples test +deps = + flake8>=2.6.2, <3.1 + rstcheck>=2.2, <3.0 +commands = + flake8 --jobs 8 --count mitmproxy pathod examples test + rstcheck README.rst \ No newline at end of file