From cc6dc4014d09d77b321ee584dd0d0305ceedfd71 Mon Sep 17 00:00:00 2001
From: Jesse Pretorius <jesse.pretorius@rackspace.co.uk>
Date: Wed, 21 Oct 2015 15:02:34 +0100
Subject: [PATCH] Add theme fix for browsable source code

This adds a fix to ensure that the published docs have the correct
link to the browsable source code as implemented in
https://review.openstack.org/236091

It also updates the dev-requirements for the docs jobs to ensure
that the requirements are in line with upstream.

It also includes an exclusion of the doc directory from the pep8
check as the documentation conf.py requires a lengthy line.

Change-Id: I7c434b9963391cc89779e90aa24cc4106b4f3534
---
 dev-requirements.txt | 6 ++++--
 doc/source/conf.py   | 3 +++
 tox.ini              | 1 +
 3 files changed, 8 insertions(+), 2 deletions(-)

diff --git a/dev-requirements.txt b/dev-requirements.txt
index 998334cd..99d83211 100644
--- a/dev-requirements.txt
+++ b/dev-requirements.txt
@@ -1,3 +1,5 @@
 ansible-lint
-oslosphinx>=2.5.0
-sphinx
+
+# this is required for the docs build jobs
+sphinx!=1.2.0,!=1.3b1,<1.3,>=1.1.2
+oslosphinx>=2.5.0 # Apache-2.0
diff --git a/doc/source/conf.py b/doc/source/conf.py
index e39721da..063d2698 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -31,6 +31,9 @@ extensions = [
     'oslosphinx'
 ]
 
+# The link to the browsable source code (for the left hand menu)
+oslosphinx_cgit_link = 'http://git.openstack.org/cgit/openstack/openstack-ansible-security'
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
diff --git a/tox.ini b/tox.ini
index fa049a21..574b9cb6 100644
--- a/tox.ini
+++ b/tox.ini
@@ -28,6 +28,7 @@ commands =
         -e '!/bin/python' \
         -e '!/usr/bin/python' \
         --exclude-dir '.*' \
+        --exclude-dir 'doc' \
         --exclude-dir '*.egg' \
         --exclude-dir '*.egg-info' \
         --exclude 'tox.ini' \