Skip to content

Commit

Permalink
Avoid linking to specific versions of docs hosted on RtD
Browse files Browse the repository at this point in the history
Instead, use URLs that redirect to the project's default version. This
gives the project more flexibility. For example, most of the time,
the default version might be stable, but if a critical documentation fix
is pushed to master, the default may be temporarily switched to latest.
  • Loading branch information
vfaronov committed Aug 1, 2017
1 parent c422379 commit 9e0103e
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 11 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Added
- In the ``mitmproxy`` console UI, you can now see a brief report
for every individual exchange on its “Detail” pane (see `docs`_).

.. _docs: http://mitmproxy-httpolice.readthedocs.io/en/stable/
.. _docs: http://mitmproxy-httpolice.readthedocs.io/

Changed
-------
Expand Down
5 changes: 2 additions & 3 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -120,8 +120,7 @@
html_theme_options = {
'fixed_sidebar': 'true',
'extra_nav_links': {
'HTTPolice user manual':
'http://httpolice.readthedocs.io/en/stable/',
'HTTPolice user manual': 'http://httpolice.readthedocs.io/',
},
}

Expand Down Expand Up @@ -344,5 +343,5 @@


intersphinx_mapping = {
'httpolice': ('http://httpolice.readthedocs.io/en/stable/', None),
'httpolice': ('http://httpolice.readthedocs.io/page/', None),
}
14 changes: 7 additions & 7 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ mitmproxy-HTTPolice is a `script for mitmproxy`__
that will check intercepted exchanges and produce an `HTTPolice`__ report.
It also works with mitmproxy’s companion tools `mitmdump`__ and `mitmweb`__.

__ http://docs.mitmproxy.org/en/stable/scripting/overview.html
__ http://httpolice.readthedocs.io/en/stable/
__ http://docs.mitmproxy.org/en/stable/mitmdump.html
__ http://docs.mitmproxy.org/en/stable/mitmweb.html
__ http://docs.mitmproxy.org/page/scripting/overview.html
__ http://httpolice.readthedocs.io/
__ http://docs.mitmproxy.org/page/mitmdump.html
__ http://docs.mitmproxy.org/page/mitmweb.html

For recent changes in mitmproxy-HTTPolice, see the `changelog`__.

Expand All @@ -32,8 +32,8 @@ Do this in a Python 3.5+ environment::
If this is giving you trouble,
see `mitmproxy docs`__ and `HTTPolice docs`__ for more detailed instructions.

__ http://docs.mitmproxy.org/en/stable/install.html
__ http://httpolice.readthedocs.io/en/stable/install.html
__ http://docs.mitmproxy.org/page/install.html
__ http://httpolice.readthedocs.io/page/install.html

.. note::

Expand Down Expand Up @@ -98,7 +98,7 @@ on its “Detail” tab:

.. image:: mitmproxy-detail.png

__ http://docs.mitmproxy.org/en/stable/mitmproxy.html
__ http://docs.mitmproxy.org/page/mitmproxy.html

How do you even know that there’s anything to see there?
Currently the only way is to follow the event log,
Expand Down

0 comments on commit 9e0103e

Please sign in to comment.