Skip to content
This repository has been archived by the owner on Mar 29, 2022. It is now read-only.

Commit

Permalink
mitmproxy and Django integration have their own docs now
Browse files Browse the repository at this point in the history
  • Loading branch information
vfaronov committed Jul 24, 2016
1 parent e55579d commit c50b8c6
Show file tree
Hide file tree
Showing 6 changed files with 18 additions and 185 deletions.
6 changes: 4 additions & 2 deletions doc/concepts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -77,8 +77,10 @@ you can use the ``-s`` option to specify notice IDs to silence::

$ httpolice -s 1089 -s 1194 ...

Every integration method has a similar mechanism.
For example, :doc:`mitmproxy` understands the same ``-s`` option.
Integration methods have similar mechanisms.
For example, `mitmproxy integration`__ understands the same ``-s`` option.

__ http://mitmproxy-httpolice.readthedocs.io/

Silencing locally
~~~~~~~~~~~~~~~~~
Expand Down
4 changes: 4 additions & 0 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,10 @@
'github_type': 'star',
'fixed_sidebar': 'true',
'extra_nav_links': {
'mitmproxy integration':
'http://mitmproxy-httpolice.readthedocs.io/',
'Django integration':
'http://django-httpolice.readthedocs.io/',
'List of all notices':
'http://pythonhosted.org/HTTPolice/notices.html',
},
Expand Down
115 changes: 0 additions & 115 deletions doc/django.rst

This file was deleted.

12 changes: 9 additions & 3 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ If you want a brief introduction, see the :doc:`quickstart`.

There is also a `list of all notices`__ that HTTPolice can output.

__ http://pythonhosted.org/HTTPolice/notices.html

.. toctree::
:maxdepth: 1

Expand All @@ -17,9 +19,13 @@ There is also a `list of all notices`__ that HTTPolice can output.
concepts
streams
har
mitmproxy
reports
api
django

__ http://pythonhosted.org/HTTPolice/notices.html
Integration packages:

- `mitmproxy integration`__
- `Django integration`__

__ http://mitmproxy-httpolice.readthedocs.io/
__ http://django-httpolice.readthedocs.io/
64 changes: 0 additions & 64 deletions doc/mitmproxy.rst

This file was deleted.

2 changes: 1 addition & 1 deletion doc/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ Now let’s run the tests and see what’s broken::
In `this example`__, the app sent a wrong ``Content-Type`` header
and HTTPolice caught it.

__ https://github.com/vfaronov/httpolice/blob/bca47b2/integration/django/example/example_app/views.py#L16
__ https://github.com/vfaronov/django-httpolice/blob/234aa3a/example/example_app/views.py#L16


More options
Expand Down

0 comments on commit c50b8c6

Please sign in to comment.