Merge lp:~cjohnston/ubuntu-ci-services-itself/theme into lp:ubuntu-ci-services-itself

[Chris Johnston]

Add an Ubuntu theme to the docs

See it live: http://162.213.34.2/rtd2/

[Francis Ginther (fginther)]

I pip installed the bootstrap theme from https://pypi.python.org/pypi/sphinx-bootstrap-theme/ to use. You might want to post a link if you have one so others can review. Looks good so far and i'll tentatively approve. Would like to know if others have a strong objection before top approving.

review: Approve

[Vincent Ladeuil (vila)]

I went to the live version, I saw, I was convinced ;)

review: Approve

[Vincent Ladeuil (vila)]

Hmm, 'pip installed' is slightly worrying, can those instructions be added to the README ?

[lp:~cjohnston/ubuntu-ci-services-itself/theme]

16. By Chris Johnston on 2013-12-09

Add a readme for the docs

[Chris Johnston (cjohnston)]

Added a REAME_DOCS file for the docs.

 review resubmit

review: Needs Resubmitting

[Ursula Junque (ursinha)]

Looks good.

review: Approve

[Vincent Ladeuil (vila)]

Thanks for the README_DOCS !

review: Approve

=== added file 'docs/README_DOCS'
--- docs/README_DOCS	1970-01-01 00:00:00 +0000
+++ docs/README_DOCS	2013-12-09 09:33:47 +0000
@@ -0,0 +1,5 @@
+These are the docs for the Ubuntu CI Engine
+
+To setup the docs with the 'United' bootstrap theme create a virtualenv and run:
+
+pip install -r requirements.txt

=== modified file 'docs/conf.py'
--- docs/conf.py	2013-11-16 10:12:08 +0000
+++ docs/conf.py	2013-12-09 09:33:47 +0000
@@ -41,16 +41,16 @@
 
 # General information about the project.
 project = u'Ubuntu CI Engine'
-copyright = u'2013, Canonical CI Engineering Team'
+copyright = u'2013, Canonical Ltd.'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = '0.0'
+#version = '0.0'
 # The full version, including alpha/beta/rc tags.
-release = '0.0'
+#release = '0.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -91,7 +91,22 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'default'
+try:
+    import sphinx_bootstrap_theme
+except ImportError:
+    html_theme = 'default'
+    html_theme_options = {}
+else:
+    html_theme = 'bootstrap'
+    html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()
+    html_theme_options = {
+        'bootswatch_theme': "united",
+        'navbar_site_name': "Documentation",
+        'navbar_pagenav': False,
+        'navbar_sidebarrel': False,
+        'source_link_position': "off",
+        'globaltoc_depth': -1,
+    }
 
 # 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

=== added file 'docs/requirements.txt'
--- docs/requirements.txt	1970-01-01 00:00:00 +0000
+++ docs/requirements.txt	2013-12-09 09:33:47 +0000
@@ -0,0 +1,2 @@
+Sphinx==1.1.3
+sphinx-bootstrap-theme==0.3.3