docs: nicer-looking landing page, link to home page from headers/footers

4 files changed, 50 insertions, 4 deletions

diff --git a/docs/conf.py b/docs/conf.py
index 2bb577a..9384dfd 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -28,7 +28,7 @@ import sys, os
 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.coverage']
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['tools']
+templates_path = ['tools/templates']
 
 # The suffix of source filenames.
 source_suffix = '.rst'
@@ -103,13 +103,15 @@ html_style = None # make readthedocs really use the default theme
 # documentation.
 html_theme_options = {
     'sidebarbgcolor':'#263193',
+    'sidebarbtncolor':'#263193',
     'footerbgcolor':'#2a1b5c',
     'relbarbgcolor':'#2a1b5c',
-    'sidebarlinkcolor':'#aabee8',#'#6d96e8',
+    'sidebarlinkcolor':'#aabee8',
     'linkcolor':'#263193',
     'visitedlinkcolor':'#263193',
     'headtextcolor':'#2a1b5c',
     'headlinkcolor':'#2a1b5c',
+    'collapsiblesidebar': True,
 }
 
 # Add any paths that contain custom themes here, relative to this directory.
@@ -145,11 +147,15 @@ html_static_path = ['tools/static']
 #html_use_smartypants = True
 
 # Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
+html_sidebars = {
+    'index': 'indexsidebar.html',
+}
 
 # Additional templates that should be rendered to pages, maps page names to
 # template names.
-#html_additional_pages = {}
+html_additional_pages = {
+    'index': 'indexcontent.html',
+}
 
 # If false, no module index is generated.
 #html_domain_indices = True
diff --git a/docs/tools/templates/indexcontent.html b/docs/tools/templates/indexcontent.html
new file mode 100644
index 0000000..209c1fb
--- /dev/null
+++ b/docs/tools/templates/indexcontent.html
@@ -0,0 +1,29 @@
+{% extends "!defindex.html" %}
+{% block body %}
+  <h1>{{ docstitle|e }}</h1>
+
+<div class="section" id="tutorial">
+<h2><a class="reference internal" href="tutorial/index.html#urwid-tutorial"><em>Tutorial</em></a><a class="headerlink" href="#tutorial" title="Permalink to this headline">¶</a></h2>
+<a class="reference external image-reference" href="tutorial/index.html#urwid-tutorial"><img alt="_images/highcolors1.png" src="_images/highcolors1.png" width="200" align="left" style="padding-right: 15px" /></a>
+<p>The <a class="reference internal" href="tutorial/index.html#urwid-tutorial"><em>Urwid Tutorial</em></a> covers example Urwid applications
+from basic to moderate complexity explaining each new concept along the way.</p>
+</div>
+<div class="section" id="manual" style="clear:both; padding-top: 8px">
+<h2><a class="reference internal" href="manual/index.html#urwid-manual"><em>Manual</em></a><a class="headerlink" href="#manual" title="Permalink to this headline">¶</a></h2>
+<a class="reference external image-reference" href="manual/index.html#urwid-manual"><img alt="_images/introduction.png" src="_images/introduction.png" width="200" align="left" style="padding-right: 15px" /></a>
+<p>The <a class="reference internal" href="manual/index.html#urwid-manual"><em>Urwid Manual</em></a> discusses each part of the library and how
+everything fits together.</p>
+</div>
+<div class="section" id="reference" style="clear:both; padding-top: 8px">
+<h2><a class="reference internal" href="reference/index.html#urwid-reference"><em>Reference</em></a><a class="headerlink" href="#reference" title="Permalink to this headline">¶</a></h2>
+<a class="reference external image-reference" href="reference/index.html#urwid-reference"><img alt="_images/urwid_widgets_1.png" src="_images/urwid_widgets_1.png" width="200" align="left" style="padding-right: 15px" /></a>
+<p>The <a class="reference internal" href="reference/index.html#urwid-reference"><em>Urwid Reference</em></a> documents all the classes and functions in the
+library individually.</p>
+</div>
+<div class="section" id="indices-and-tables" style="clear: both; padding-top: 8px">
+<h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h2>
+<ul class="simple">
+<li><a class="reference internal" href="genindex.html"><em>Index</em></a></li>
+<li><a class="reference internal" href="search.html"><em>Search Page</em></a></li>
+</div>
+{% endblock %}
diff --git a/docs/tools/templates/indexsidebar.html b/docs/tools/templates/indexsidebar.html
new file mode 100644
index 0000000..704bd8b
--- /dev/null
+++ b/docs/tools/templates/indexsidebar.html
@@ -0,0 +1,6 @@
+
+<h4><a class="reference internal" href="tutorial/index.html#urwid-tutorial">Tutorial</a></h4>
+<h4><a class="reference internal" href="manual/index.html#urwid-manual">Manual</a></h4>
+<h4><a class="reference internal" href="reference/index.html#urwid-reference">Reference</a></h4>
+<h4><a class="reference internal" href="genindex.html"><em>Index</em></a></h4>
+<br/>
diff --git a/docs/tools/templates/layout.html b/docs/tools/templates/layout.html
new file mode 100644
index 0000000..bba7e42
--- /dev/null
+++ b/docs/tools/templates/layout.html
@@ -0,0 +1,5 @@
+{% extends "!layout.html" %}
+{% block rootrellink %}
+    <li><a href="http://excess.org/urwid/">Urwid Homepage</a> &raquo;</li>
+    {{ super() }}
+{% endblock %}