couchdb-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From nsla...@apache.org
Subject git commit: Clean up sidebar and front page of docs
Date Sat, 01 Dec 2012 16:09:55 GMT
Updated Branches:
  refs/heads/docs 4fe217411 -> cd37d2fb3


Clean up sidebar and front page of docs


Project: http://git-wip-us.apache.org/repos/asf/couchdb/repo
Commit: http://git-wip-us.apache.org/repos/asf/couchdb/commit/cd37d2fb
Tree: http://git-wip-us.apache.org/repos/asf/couchdb/tree/cd37d2fb
Diff: http://git-wip-us.apache.org/repos/asf/couchdb/diff/cd37d2fb

Branch: refs/heads/docs
Commit: cd37d2fb30245829fe3e2f007b538c899860537f
Parents: 4fe2174
Author: Noah Slater <nslater@apache.org>
Authored: Sat Dec 1 16:09:51 2012 +0000
Committer: Noah Slater <nslater@apache.org>
Committed: Sat Dec 1 16:09:51 2012 +0000

----------------------------------------------------------------------
 share/doc/src/conf.py            |   74 ++++++++++++---------------------
 share/doc/src/index.rst          |   13 ++----
 share/doc/templates/sidebar.html |    8 ++--
 3 files changed, 36 insertions(+), 59 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/couchdb/blob/cd37d2fb/share/doc/src/conf.py
----------------------------------------------------------------------
diff --git a/share/doc/src/conf.py b/share/doc/src/conf.py
index 7405a9e..8c11a56 100644
--- a/share/doc/src/conf.py
+++ b/share/doc/src/conf.py
@@ -35,41 +35,21 @@ pygments_style = "sphinx"
 html_theme = "default"
 
 html_theme_options = {
-
-	"footerbgcolor": "#465158", #
-	"sidebarbgcolor": "#E8ECEF", #
-	"sidebartextcolor": "#444444", #
-	"sidebarlinkcolor": "#444444", #
-	"relbarbgcolor": "#465158", #
-	"headbgcolor": "inherit", #
-	"headtextcolor": "#111111", #
-	"headlinkcolor": "#111111", #
-	"linkcolor": "#355f7c",
-	"visitedlinkcolor": "#355f7c",
-	"codebgcolor": "#EEEEEE", #
-	"codetextcolor": "#00000", #
-
+    "footerbgcolor": "#465158",
+    "sidebarbgcolor": "#E8ECEF",
+    "sidebartextcolor": "#444444",
+    "sidebarlinkcolor": "#444444",
+    "relbarbgcolor": "#465158",
+    "headbgcolor": "inherit",
+    "headtextcolor": "#111111",
+    "headlinkcolor": "#111111",
+    "linkcolor": "#355f7c", # @@
+    "visitedlinkcolor": "#355f7c", # @@
+    "codebgcolor": "#EEEEEE",
+    "codetextcolor": "#00000",
 }
 
-# @@sidebars - content like in django docs
-
-# [theme]
-# inherit = basic
-# stylesheet = default.css
-# pygments_style = sphinx
-# 
-# [options]
-# rightsidebar = false
-# stickysidebar = false
-# collapsiblesidebar = false
-# externalrefs = false
-
-# @ experiment with these
-
-# bodyfont = sans-serif
-# headfont = 'Trebuchet MS', sans-serif
-
-html_logo = "../images/logo.png" # @@ waiting on logo
+html_logo = "../images/logo.png"
 
 html_favicon = "../images/favicon.ico"
 
@@ -86,12 +66,12 @@ html_sidebars= {
 text_newlines = "native"
 
 latex_documents = [(
-       "index",
-       "CouchDB.tex",
-       project,
-       "",
-       "manual",
-       True
+    "index",
+    "CouchDB.tex",
+    project,
+    "",
+    "manual",
+    True
 )]
 
 latex_elements = {
@@ -99,12 +79,12 @@ latex_elements = {
 }
 
 texinfo_documents = [(
-       "index",
-       "CouchDB",
-       project,
-       "",
-       "CouchDB",
-       "The Apache CouchDB database",
-       "Databases",
-       True
+    "index",
+    "CouchDB",
+    project,
+    "",
+    "CouchDB",
+    "The Apache CouchDB database",
+    "Databases",
+    True
 )]

http://git-wip-us.apache.org/repos/asf/couchdb/blob/cd37d2fb/share/doc/src/index.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/index.rst b/share/doc/src/index.rst
index a980774..78994fa 100644
--- a/share/doc/src/index.rst
+++ b/share/doc/src/index.rst
@@ -10,16 +10,13 @@
 .. License for the specific language governing permissions and limitations under
 .. the License.
 
-Apache CouchDB
-==============
+Introduction
+============
 
-|Apache CouchDB(TM)|_ is a database that uses JSON for documents, JavaScript for
-MapReduce queries, and regular HTTP for an API
+|Apache CouchDB(TM)|_ is a document database built for the web.
 
-At the moment, this documentation only covers the basics. In
-subsequent releases we hope to expand the documentation. If you
-would like to help with that, please subscribe to the `developer mailing list
-<http://couchdb.apache.org/#mailing-list>`_ and give a shout.
+If you would like to help document the project, please send a note to the
+`developer mailing list <http://couchdb.apache.org/#mailing-list>`_.
 
 Contents
 ========

http://git-wip-us.apache.org/repos/asf/couchdb/blob/cd37d2fb/share/doc/templates/sidebar.html
----------------------------------------------------------------------
diff --git a/share/doc/templates/sidebar.html b/share/doc/templates/sidebar.html
index bed0a19..4fdea02 100644
--- a/share/doc/templates/sidebar.html
+++ b/share/doc/templates/sidebar.html
@@ -2,8 +2,8 @@
 
 <ul>
 <li><a href="https://couchdb.apache.org/">Homepage</a></li>
-<li><a href="http://wiki.apache.org/couchdb/">Project Wiki</a></li>
+<li><a href="http://wiki.apache.org/couchdb/">Wiki</a></li>
 <li><a href="https://couchdb.apache.org/#mailing-list">Mailing Lists</a></li>
-<li><a href="http://webchat.freenode.net/?channels=couchdb">IRC Channel</a></li>
-<li><a href="https://issues.apache.org/jira/browse/CouchDB">Issue Tracker</a></li>
-</ul>
\ No newline at end of file
+<li><a href="http://webchat.freenode.net/?channels=couchdb">IRC</a></li>
+<li><a href="https://issues.apache.org/jira/browse/CouchDB">Issues</a></li>
+</ul>


Mime
View raw message