Adopt the (work-in-progress) riverbank theme for the docs.

Build HTML docs by default.

Author: philthompson10

doc/Makefile

@@ -19,7 +19,9 @@ ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
 # the i18n builder cannot share the environment and doctrees with the others
 I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
 
-.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+.PHONY: default help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+default: html
 
 help:
 	@echo "Please use \`make <target>' where <target> is one of"

doc/conf.py

@@ -55,8 +55,13 @@
 version_file = open(os.path.join('..', 'pyqtdeploy', 'version.py'))
 release = version_file.read().strip().split('\n')[0].split()[-1][1:-1]
 version_file.close()
+del version_file
 # The short X.Y version.
-version = release.split('-')[0]
+version_parts = release.split('.')
+if version_parts[-1].startswith('dev'):
+    del version_parts[-1]
+version = '.'.join(version_parts)
+del version_parts
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -99,163 +104,15 @@
 
 # -- Options for HTML output ----------------------------------------------
 
-# The theme to use for HTML and HTML Help pages.  See the documentation for
-# a list of builtin themes.
-html_theme = 'classic'
-
-# 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 = {}
+# The theme to use for HTML and HTML Help pages.
+html_theme = 'riverbank'
 
 # Add any paths that contain custom themes here, relative to this directory.
-#html_theme_path = []
+html_theme_path = ['.']
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
-#html_title = None
-
-# A shorter title for the navigation bar.  Default is the same as html_title.
-#html_short_title = None
-
-# The name of an image file (relative to this directory) to place at the top
-# of the sidebar.
-html_logo = 'static/logo.png'
-
-# The name of an image file (within the static path) to use as favicon of the
-# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
-# pixels large.
-html_favicon = 'static/logo_tn.ico'
-
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['static']
-
-# Add any extra paths that contain custom files (such as robots.txt or
-# .htaccess) here, relative to this directory. These files are copied
-# directly to the root of the documentation.
-#html_extra_path = []
-
-# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
-# using the given strftime format.
-#html_last_updated_fmt = '%b %d, %Y'
-
-# If true, SmartyPants will be used to convert quotes and dashes to
-# typographically correct entities.
-#html_use_smartypants = True
-
-# Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
-
-# Additional templates that should be rendered to pages, maps page names to
-# template names.
-#html_additional_pages = {}
-
-# If false, no module index is generated.
-#html_domain_indices = True
-
-# If false, no index is generated.
-#html_use_index = True
-
-# If true, the index is split into individual pages for each letter.
-#html_split_index = False
-
-# If true, links to the reST sources are added to the pages.
-#html_show_sourcelink = True
-
-# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-#html_show_sphinx = True
-
-# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
-#html_show_copyright = True
-
-# If true, an OpenSearch description file will be output, and all pages will
-# contain a <link> tag referring to it.  The value of this option must be the
-# base URL from which the finished HTML is served.
-#html_use_opensearch = ''
-
-# This is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = None
+html_title = '%s v%s User Guide' % (project, release)
 
 # Output file base name for HTML help builder.
 htmlhelp_basename = 'pyqtdeploydoc'
-
-
-# -- Options for LaTeX output ---------------------------------------------
-
-latex_elements = {
-# The paper size ('letterpaper' or 'a4paper').
-#'papersize': 'letterpaper',
-
-# The font size ('10pt', '11pt' or '12pt').
-#'pointsize': '10pt',
-
-# Additional stuff for the LaTeX preamble.
-#'preamble': '',
-}
-
-# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title,
-#  author, documentclass [howto, manual, or own class]).
-latex_documents = [
-  ('index', 'pyqtdeploy.tex', 'pyqtdeploy Documentation',
-   'Riverbank Computing Limited', 'manual'),
-]
-
-# The name of an image file (relative to this directory) to place at the top of
-# the title page.
-#latex_logo = None
-
-# For "manual" documents, if this is true, then toplevel headings are parts,
-# not chapters.
-#latex_use_parts = False
-
-# If true, show page references after internal links.
-#latex_show_pagerefs = False
-
-# If true, show URL addresses after external links.
-#latex_show_urls = False
-
-# Documents to append as an appendix to all manuals.
-#latex_appendices = []
-
-# If false, no module index is generated.
-#latex_domain_indices = True
-
-
-# -- Options for manual page output ---------------------------------------
-
-# One entry per manual page. List of tuples
-# (source start file, name, description, authors, manual section).
-man_pages = [
-    ('index', 'pyqtdeploy', 'pyqtdeploy Documentation',
-     ['Riverbank Computing Limited'], 1)
-]
-
-# If true, show URL addresses after external links.
-#man_show_urls = False
-
-
-# -- Options for Texinfo output -------------------------------------------
-
-# Grouping the document tree into Texinfo files. List of tuples
-# (source start file, target name, title, author,
-#  dir menu entry, description, category)
-texinfo_documents = [
-  ('index', 'pyqtdeploy', 'pyqtdeploy Documentation',
-   'Riverbank Computing Limited', 'pyqtdeploy', 'One line description of project.',
-   'Miscellaneous'),
-]
-
-# Documents to append as an appendix to all manuals.
-#texinfo_appendices = []
-
-# If false, no module index is generated.
-#texinfo_domain_indices = True
-
-# How to display URL addresses: 'footnote', 'no', or 'inline'.
-#texinfo_show_urls = 'footnote'
-
-# If true, do not generate a @detailmenu in the "Top" node's menu.
-#texinfo_no_detailmenu = False

doc/riverbank/layout.html

@@ -0,0 +1,4 @@
+{% extends "classic/layout.html" %}
+{% set favicon = "logo_tn.png" %}
+{% set logo = "logo.png" %}
+{% set show_source = False %}

doc/static/logo.png renamed to doc/riverbank/static/logo.png

@@ -0,0 +1,17 @@
+@import url("classic.css");
+
+div.body h1,
+div.body h2 {
+    border-radius: 10px;
+    margin-right: 0px;
+}
+
+h1 a:visited,
+h2 a:visited {
+    color: white;
+    text-decoration: none;
+}
+
+.classtable {
+    width: 100%;
+}

doc/static/logo_tn.ico renamed to doc/riverbank/static/logo_tn.ico

@@ -0,0 +1,20 @@
+[theme]
+inherit = classic
+stylesheet = riverbank.css
+
+[options]
+footerbgcolor = white
+footertextcolor = black
+sidebarbgcolor = white
+sidebartextcolor = black
+sidebarlinkcolor = #4186cb
+relbarbgcolor = white
+relbartextcolor = black
+relbarlinkcolor = #4186cb
+headbgcolor = #4186cb
+headtextcolor = white
+headlinkcolor = #4186cb
+linkcolor = #4186cb
+visitedlinkcolor = #4186cb
+
+bodyfont = Copperplate / Copperplate Gothic Light, sans-serif