diff options
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 30 |
1 files changed, 18 insertions, 12 deletions
@@ -26,7 +26,7 @@ and pathod websites. |mitmproxy_site| -The latest documentation for mitmproxy is also available on ReadTheDocs. +The latest documentation for mitmproxy is available on our website. |mitmproxy_docs| @@ -95,6 +95,12 @@ requirements installed, and you can run the full test suite (including tests for tox +To run complete tests with a full coverage report, you can use the following command: + +.. code-block:: bash + + tox -- --verbose --cov-report=term + For speedier testing, we recommend you run `pytest`_ directly on individual test files or folders: .. code-block:: bash @@ -110,19 +116,18 @@ suite. The project tries to maintain 100% test coverage and enforces this strict Documentation ------------- -The mitmproxy documentation is build using Sphinx_, which is installed -automatically if you set up a development environment as described above. After -installation, you can render the documentation like this: +The following tools are required to build the mitmproxy docs: + +- Hugo_ +- modd_ +- yarn_ .. code-block:: bash cd docs - make clean - make html - make livehtml + yarn + modd -The last command invokes `sphinx-autobuild`_, which watches the Sphinx directory and rebuilds -the documentation when a change is detected. Code Style ---------- @@ -146,7 +151,7 @@ with the following command: :alt: mitmproxy.org .. |mitmproxy_docs| image:: https://shields.mitmproxy.org/api/docs-latest-brightgreen.svg - :target: http://docs.mitmproxy.org/en/latest/ + :target: https://mitmproxy.org/docs/latest/ :alt: mitmproxy documentation .. |mitmproxy_discourse| image:: https://shields.mitmproxy.org/api/https%3A%2F%2F-discourse.mitmproxy.org-orange.svg @@ -181,8 +186,9 @@ with the following command: .. _virtualenv: https://virtualenv.pypa.io/ .. _`pytest`: http://pytest.org/ .. _tox: https://tox.readthedocs.io/ -.. _Sphinx: http://sphinx-doc.org/ -.. _sphinx-autobuild: https://pypi.python.org/pypi/sphinx-autobuild +.. _Hugo: https://gohugo.io/ +.. _modd: https://github.com/cortesi/modd +.. _yarn: https://yarnpkg.com/en/ .. _PEP8: https://www.python.org/dev/peps/pep-0008 .. _`Google Style Guide`: https://google.github.io/styleguide/pyguide.html .. _forums: https://discourse.mitmproxy.org/ |