Transition to sphinx_rtd_theme (#154)

.travis.yml

@@ -4,7 +4,7 @@ python:
   - 3.4
 
 install:
-  - pip install sphinx
+  - pip install sphinx sphinx_rtd_theme
 
 script:
   - make ${TARGET}

src/conf.py

@@ -14,6 +14,8 @@
 import os
 import sys
 
+import sphinx_rtd_theme
+
 sys.path.insert(0, os.path.abspath('../ext'))
 
 needs_sphinx = "1.2"
@@ -40,9 +42,12 @@
 
 pygments_style = "sphinx"
 
-html_theme = "couchdb"
+html_theme = "sphinx_rtd_theme"
+html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 
-html_theme_path = ['../themes']
+html_theme_options = {
+    'canonical_url': "http://docs.couchdb.org/en/stable/"
+}
 
 templates_path = ["../templates"]
 
@@ -54,7 +59,7 @@
     'Documentation'
 ])
 
-html_style = "rtd.css"
+#html_style = "css/rtd_theme.css"
 
 html_logo = "../images/logo.png"
 
@@ -68,24 +73,22 @@
 }
 
 html_context = {
-    "ga_code": "UA-658988-6"
+    "ga_code": "UA-658988-6",
+    # Enable the "Edit in GitHub link within the header of each page.
+    'display_github': True,
+    # Set the following variables to generate the resulting github URL for each page. 
+    # Format Template: https://{{ github_host|default("github.com") }}/{{ github_user }}/{{ github_repo }}/blob/{{ github_version }}{{ conf_py_path }}{{ pagename }}{{ suffix }}
+    'github_user': 'apache',
+    'github_repo': 'couchdb-documentation',
+    'github_version': 'master/src/' 
 }
 
-html_sidebars = {
-    "**": [
-        "searchbox.html",
-        "localtoc.html",
-        "relations.html",
-        "utilities.html",
-        "help.html",
-        "tracking.html",
-    ]
-}
+master_doc = 'index'
 
 text_newlines = "native"
 
 latex_documents = [(
-    "contents",
+    "index",
     "CouchDB.tex",
     project,
     "",
@@ -120,3 +123,5 @@
 
 github_docs_path = 'src'
 
+def setup(app):
+    app.add_stylesheet('css/rtd_theme.css')

src/contents.rst → src/index.rst

@@ -10,10 +10,16 @@
 .. License for the specific language governing permissions and limitations under
 .. the License.
 
+.. This file exists solely to hold the top-level Table of Contents.
+
 =============================================
 |Apache CouchDB(TM)|_ |release| Documentation
 =============================================
 
+Welcome! This is the documentation for Apache CouchDB |release|.
+
+Table of Contents
+=================
 .. toctree::
     :maxdepth: 3
     :numbered: 3

static/css/rtd_theme.css

@@ -0,0 +1,49 @@
+/*
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not
+ * use this file except in compliance with the License. You may obtain a copy of
+ * the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations under
+ * the License.
+ */
+
+@import url("theme.css");
+
+.wy-side-nav-search {
+  background-color: #370000;
+}
+
+.wy-nav-content {
+  background-color: #eee;
+}
+
+.wy-menu h2 {
+  margin: 1em auto 0.3em 0.25em;
+  color: #bbb;
+}
+
+/* -- index page ------------------------------------------------------------ */
+
+table.contentstable {
+    width: 90%;
+}
+
+table.contentstable p.biglink {
+    line-height: 150%;
+}
+
+a.biglink {
+    font-size: 1.3em;
+}
+
+span.linkdescr {
+    font-style: italic;
+    padding-top: 5px;
+    font-size: 90%;
+}
+

templates/layout.html

@@ -1,5 +1,4 @@
 <!--
-
 Licensed under the Apache License, Version 2.0 (the "License"); you may not use
 this file except in compliance with the License. You may obtain a copy of the
 License at
@@ -10,18 +9,47 @@
 under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
 CONDITIONS OF ANY KIND, either express or implied. See the License for the
 specific language governing permissions and limitations under the License.
-
 -->
 
-{% extends "!layout.html" %}
-{{ rellinks.append(('contents', 'Contents', '', 'Contents')) }}
-{%- block rootrellink %}
-  <li><a href="{{ pathto('index') }}">{{ shorttitle|e }}</a>{{ reldelim1 }}</li>
-{%- endblock %}
-{%- block sidebarlogo %}
-  {%- if logo %}
-    <p class="logo"><a href="{{ pathto('index') }}">
-      <img class="logo" src="{{ pathto('_static/' + logo, 1) }}" alt="Logo"/>
-    </a></p>
-  {%- endif %}
-{%- endblock %}
+{%- extends "!layout.html" %}
+{% block menu %}
+<h2>Table of Contents</h2>
+{{ super() }}
+<h2>Quick Reference</h2>
+<ul>
+<li><a href="{{ pathto('http-api') }}">HTTP API Reference</a></li>
+<li><a href="{{ pathto('config-ref') }}">Configuration Reference</a></li>
+</ul>
+
+{% if local %}
+<h2>Local Links</h2>
+<ul>
+<li><a href="../">Fauxton</a></li>
+</ul>
+{% endif %}
+
+<h2>More Help</h2>
+<ul>
+<li><a href="https://couchdb.apache.org/"{% if not local %} onclick="_gaq.push(['_link', 'https://couchdb.apache.org/']); return false;"{% endif %}>CouchDB Homepage</a></li>
+<li><a href="https://couchdb.apache.org/#mailing-list"{% if not local %} onclick="_gaq.push(['_link', 'https://couchdb.apache.org/#mailing-list']); return false;"{% endif %}>Mailing Lists</a></li>
+<li><a href="http://webchat.freenode.net/?channels=couchdb">IRC</a></li>
+<li><a href="https://github.com/apache/couchdb/issues">Issue Tracker</a></li>
+<li><a href="{{ pathto('download') }}">Download Docs</a></li>
+</ul>
+
+{% if not local %}
+<script type="text/javascript">
+  var _gaq = _gaq || [];
+  _gaq.push(['_setAccount', '{{ ga_code }}']);
+  _gaq.push(['_setDomainName', 'couchdb.org']);
+  _gaq.push(['_setAllowLinker', true]);
+  _gaq.push(['_trackPageview']);
+
+  (function() {
+    var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+    ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+    var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+  })();
+</script>
+{% endif %}
+{% endblock %}

templates/pages/index.html

@@ -13,7 +13,15 @@
 
 -->
 
-{% extends "defindex.html" %}
+{% extends "layout.html" %}
+{% set title = _('Overview') %}
+{% block body %}
+  <h1>{{ docstitle|e }}</h1>
+  <p>
+    {{ _('Welcome! This is') }}
+    {% block description %}{{ _('the documentation for') }} {{ project|e }}
+    {{ release|e }}{% if last_updated %}, {{ _('last updated') }} {{ last_updated|e }}{% endif %}{% endblock %}.
+</p>
 {% block tables %}
 <h2>Meet CouchDB</h2>
 <table class="contentstable" align="center">
@@ -177,14 +185,11 @@ <h2>Reference Documentation &amp; Advanced Topics</h2>
 
 <h2>Links</h2>
 <table class="contentstable" align="center"><tr>
-  <td width="50%">
-    <p class="biglink"><a class="biglink" href="{{ pathto("contents") }}">Documentation Contents</a></p>
-    <p class="biglink"><a class="biglink" href="{{ pathto("http-api") }}">HTTP API Index</a></p>
-    <p class="biglink"><a class="biglink" href="{{ pathto("contributing") }}">Contributing to this Documentation</a></p>
-  </td><td width="50%">
-    <p class="biglink"><a class="biglink" href="http://couchdb.org/">CouchDB Web site</a></p>
-    <p class="biglink"><a class="biglink" href="http://couchdb.org/#download">Download</a></p>
-    <p class="biglink"><a class="biglink" href="http://couchdb.org/#mailing-list">Mailing Lists</a></p>
+  <td>
+    <p class="biglink"><a class="biglink" href="http://couchdb.org/#download">Download CouchDB</a></p>
+    <p class="biglink"><a class="biglink" href="{{ pathto("http-api") }}">HTTP API Reference</a></p>
+    <p class="biglink"><a class="biglink" href="{{ pathto("config-ref") }}">Configuration Reference</a></p>
   </td></tr>
 </table>
 {% endblock %}
+{% endblock %}