Improve Sphinx docs navigation

- include changelog into the Sphinx ToC
- expand to show the current page's headings in the sidebar
- a few other tweaks

Author: vfaronov

CHANGELOG.rst

@@ -1,10 +1,5 @@
-Changelog
-=========
-
-All notable changes to HTTPolice will be documented in this file.
-
-This project adheres to `Semantic Versioning <http://semver.org/>`_
-(which means it is unstable until 1.0).
+History of changes
+==================
 
 
 Unreleased

doc/conf.py

@@ -13,6 +13,7 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
+from collections import OrderedDict
 import sys
 import os
 
@@ -121,15 +122,14 @@
      'github_user': 'vfaronov',
      'github_repo': 'httpolice',
      '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',
-     },
+     'extra_nav_links': OrderedDict([
+          ('mitmproxy integration',
+           'http://mitmproxy-httpolice.readthedocs.io/'),
+          ('Django integration',
+           'http://django-httpolice.readthedocs.io/'),
+          ('List of all notices',
+           'http://pythonhosted.org/HTTPolice/notices.html'),
+     ]),
 }
 
 # Add any paths that contain custom themes here, relative to this directory.

doc/history.rst

@@ -0,0 +1 @@
+.. include:: ../CHANGELOG.rst

doc/index.rst

@@ -5,18 +5,13 @@ HTTPolice is a lint for HTTP requests and responses.
 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`.
+For a brief hands-on introduction, jump to the :doc:`quickstart`.
 
-There is also a `list of all notices`__ that HTTPolice can output.
-
-__ http://pythonhosted.org/HTTPolice/notices.html
-
-For recent changes in HTTPolice, see the `changelog`__.
-
-__ https://github.com/vfaronov/httpolice/blob/master/CHANGELOG.rst
+Contents
+--------
 
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
 
    quickstart
    install
@@ -25,8 +20,11 @@ __ https://github.com/vfaronov/httpolice/blob/master/CHANGELOG.rst
    har
    reports
    api
+   history
+
 
-Integration packages:
+Integration packages
+--------------------
 
 - `mitmproxy integration`__
 - `Django integration`__
@@ -35,3 +33,11 @@ Integration packages:
 __ http://mitmproxy-httpolice.readthedocs.io/
 __ http://django-httpolice.readthedocs.io/
 __ https://chrome.google.com/webstore/detail/httpolice-devtool/hnlnhebgfcfemjaphgbeokdnfpgbnhgn
+
+
+Supplementary materials
+-----------------------
+
+- `List of all notices`__ that HTTPolice can output
+
+__ http://pythonhosted.org/HTTPolice/notices.html