Improve user manual layout

doc/conf.py

@@ -115,7 +115,18 @@
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
-#html_theme_options = {}
+html_theme_options = {
+     'description': 'Lint for HTTP',
+     'github_button': 'true',
+     'github_user': 'vfaronov',
+     'github_repo': 'httpolice',
+     'github_type': 'star',
+     'fixed_sidebar': 'true',
+     'extra_nav_links': {
+          'List of all notices':
+               'http://pythonhosted.org/HTTPolice/notices.html',
+     },
+}
 
 # Add any paths that contain custom themes here, relative to this directory.
 #html_theme_path = []
@@ -156,7 +167,15 @@
 #html_use_smartypants = True
 
 # Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
+html_sidebars = {
+    '**': [
+        'about.html',
+        'navigation.html',
+        'relations.html',
+        'searchbox.html',
+        'donate.html',
+    ]
+}
 
 # Additional templates that should be rendered to pages, maps page names to
 # template names.

doc/index.rst

@@ -7,6 +7,8 @@ It checks them for conformance to standards and best practices.
 This manual explains all features of HTTPolice in detail.
 If you want a brief introduction, see the :doc:`quickstart`.
 
+There is also a `list of all notices`__ that HTTPolice can output.
+
 .. toctree::
    :maxdepth: 1
 
@@ -20,6 +22,4 @@ If you want a brief introduction, see the :doc:`quickstart`.
    api
    django
 
-There is also a `list of all notices`__ that HTTPolice can output.
-
 __ http://pythonhosted.org/HTTPolice/notices.html

doc/mitmproxy.rst

@@ -49,7 +49,7 @@ that prints the path to the script file::
   $ python -m mitmproxy_httpolice
   /home/vasiliy/.local/lib/python2.7/site-packages/mitmproxy_httpolice.py
 
-``-o html`` tells HTTPolice to produce :doc:`HTML reports <reports>`
+``-o html`` tells HTTPolice to produce HTML reports
 (omit it if you want a plain text report).
 Finally, ``report.html`` is the name of the output file.