couchdb-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From nsla...@apache.org
Subject git commit: Added sidebar to docs
Date Sat, 01 Dec 2012 15:47:47 GMT
Updated Branches:
  refs/heads/docs fe62f76ad -> 4fe217411


Added sidebar to docs


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

Branch: refs/heads/docs
Commit: 4fe2174113d228271ed97d8a8be0b1d77a2b851a
Parents: fe62f76
Author: Noah Slater <nslater@apache.org>
Authored: Sat Dec 1 15:46:04 2012 +0000
Committer: Noah Slater <nslater@apache.org>
Committed: Sat Dec 1 15:47:36 2012 +0000

----------------------------------------------------------------------
 share/doc/build/Makefile.am      |    2 +
 share/doc/src/conf.py            |   46 ++++++++++++--------------------
 share/doc/src/index.rst          |    8 +++---
 share/doc/templates/sidebar.html |    9 ++++++
 4 files changed, 32 insertions(+), 33 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/couchdb/blob/4fe21741/share/doc/build/Makefile.am
----------------------------------------------------------------------
diff --git a/share/doc/build/Makefile.am b/share/doc/build/Makefile.am
index df45cba..bca680f 100644
--- a/share/doc/build/Makefile.am
+++ b/share/doc/build/Makefile.am
@@ -52,6 +52,8 @@
 
 # @@ design CouchDB theme
 
+# @@ update homepage IRC link to: http://webchat.freenode.net/?channels=couchdb
+
 # -----------------------------------------------------------------------------
 
 SPHINXOPTS = \

http://git-wip-us.apache.org/repos/asf/couchdb/blob/4fe21741/share/doc/src/conf.py
----------------------------------------------------------------------
diff --git a/share/doc/src/conf.py b/share/doc/src/conf.py
index 1470694..7405a9e 100644
--- a/share/doc/src/conf.py
+++ b/share/doc/src/conf.py
@@ -37,27 +37,22 @@ html_theme = "default"
 html_theme_options = {
 
 	"footerbgcolor": "#465158", #
-	"footertextcolor": "#ffffff",
 	"sidebarbgcolor": "#E8ECEF", #
-	"sidebarbtncolor": "#3c6e83",
 	"sidebartextcolor": "#444444", #
 	"sidebarlinkcolor": "#444444", #
 	"relbarbgcolor": "#465158", #
-	"relbartextcolor": "#ffffff",
-	"relbarlinkcolor": "#ffffff",
-	"bgcolor": "#ffffff",
-	"textcolor": "#000000",
 	"headbgcolor": "inherit", #
 	"headtextcolor": "#111111", #
 	"headlinkcolor": "#111111", #
 	"linkcolor": "#355f7c",
 	"visitedlinkcolor": "#355f7c",
-	"codebgcolor": "#eeffcc",
-	"codetextcolor": "#333333",
+	"codebgcolor": "#EEEEEE", #
+	"codetextcolor": "#00000", #
 
 }
 
-# 
+# @@sidebars - content like in django docs
+
 # [theme]
 # inherit = basic
 # stylesheet = default.css
@@ -68,26 +63,9 @@ html_theme_options = {
 # stickysidebar = false
 # collapsiblesidebar = false
 # externalrefs = false
-# 
-# footerbgcolor    = #11303d
-# footertextcolor  = #ffffff
-# sidebarbgcolor   = #1c4e63
-# sidebarbtncolor  = #3c6e83
-# sidebartextcolor = #ffffff
-# sidebarlinkcolor = #98dbcc
-# relbarbgcolor    = #133f52
-# relbartextcolor  = #ffffff
-# relbarlinkcolor  = #ffffff
-# bgcolor          = #ffffff
-# textcolor        = #000000
-# headbgcolor      = #f2f2f2
-# headtextcolor    = #20435c
-# headlinkcolor    = #c60f0f
-# linkcolor        = #355f7c
-# visitedlinkcolor = #355f7c
-# codebgcolor      = #eeffcc
-# codetextcolor    = #333333
-# 
+
+# @ experiment with these
+
 # bodyfont = sans-serif
 # headfont = 'Trebuchet MS', sans-serif
 
@@ -95,6 +73,16 @@ html_logo = "../images/logo.png" # @@ waiting on logo
 
 html_favicon = "../images/favicon.ico"
 
+templates_path = "../templates"
+
+html_sidebars= {
+    "**": [
+        "localtoc.html",
+        "relations.html",
+        "../templates/sidebar.html",
+    ]
+}
+
 text_newlines = "native"
 
 latex_documents = [(

http://git-wip-us.apache.org/repos/asf/couchdb/blob/4fe21741/share/doc/src/index.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/index.rst b/share/doc/src/index.rst
index 60de0c5..a980774 100644
--- a/share/doc/src/index.rst
+++ b/share/doc/src/index.rst
@@ -10,14 +10,14 @@
 .. License for the specific language governing permissions and limitations under
 .. the License.
 
-Apache CouchDB Documentation
-============================
+Apache CouchDB
+==============
 
 |Apache CouchDB(TM)|_ is a database that uses JSON for documents, JavaScript for
 MapReduce queries, and regular HTTP for an API
 
-At the moment, this documentation only covers the basics of CouchDB. In
-subsequent releases we hope to expand the documentation significantly. If you
+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.
 

http://git-wip-us.apache.org/repos/asf/couchdb/blob/4fe21741/share/doc/templates/sidebar.html
----------------------------------------------------------------------
diff --git a/share/doc/templates/sidebar.html b/share/doc/templates/sidebar.html
new file mode 100644
index 0000000..bed0a19
--- /dev/null
+++ b/share/doc/templates/sidebar.html
@@ -0,0 +1,9 @@
+<h3>More Help</h3>
+
+<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="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


Mime
View raw message