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 includes an exclusion of the doc directory from the pep8
check as the documentation conf.py requires the lengthy line.

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

Change-Id: I52b5ede12667cf454d99a053e20eba4461b8ee75

dev-requirements.txt

@@ -4,6 +4,8 @@ hacking>=0.10.0,<0.11
 pep8==1.5.7
 pyflakes==0.8.1
 mccabe==0.2.1 # capped for flake8
+bashate>=0.2 # Apache-2.0
+
+# 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
-bashate>=0.2 # Apache-2.0

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'
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 

scripts/gate-check-lint.sh

@@ -41,7 +41,7 @@ fi
 # NOTE:
 #     Template files are skipped because they are python executables potentially with Jinja2
 #     expressions and the jinja2 causes a flake8 failures.
-flake8 --ignore=F403,H303 $(grep -rln -e '^#!/usr/bin/env python' -e '^#!/bin/python' -e '^#!/usr/bin/python' * | grep -v 'templates/')
+flake8 --ignore=F403,H303 $(grep -rln -e '^#!/usr/bin/env python' -e '^#!/bin/python' -e '^#!/usr/bin/python' * | grep -v 'templates/\|^doc/')
 
 # Create keys if they don't already exist.
 ssh_key_create

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-dir '*templates' \