couchdb-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From nsla...@apache.org
Subject [2/3] git commit: Some more docs work
Date Tue, 27 Nov 2012 22:47:30 GMT
Some more docs work


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

Branch: refs/heads/docs
Commit: 3c0e87e97709ec4b137ad5e4fffd36635e205039
Parents: 4641aef
Author: Noah Slater <nslater@apache.org>
Authored: Tue Nov 27 22:47:02 2012 +0000
Committer: Noah Slater <nslater@apache.org>
Committed: Tue Nov 27 22:47:02 2012 +0000

----------------------------------------------------------------------
 share/doc/build/Makefile.am |    3 ++
 share/doc/src/conf.py       |   59 +++++++++-----------------------------
 share/doc/src/index.rst     |   23 ++++++--------
 3 files changed, 27 insertions(+), 58 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/couchdb/blob/3c0e87e9/share/doc/build/Makefile.am
----------------------------------------------------------------------
diff --git a/share/doc/build/Makefile.am b/share/doc/build/Makefile.am
index 33a7485..a3548e0 100644
--- a/share/doc/build/Makefile.am
+++ b/share/doc/build/Makefile.am
@@ -50,6 +50,8 @@
 # @@ but dont know why
 # @@ oh, probably because i didn't install build-essential
 
+# @@ design CouchDB theme
+
 # -----------------------------------------------------------------------------
 
 SPHINXOPTS = \
@@ -304,6 +306,7 @@ distclean-local:
 	rm -fr latex
 	rm -fr texinfo
 
+# We handle exit code manually. Please fix if there is a better way.
 distcheck-hook:
 	if test ! -s $(info_file_dist); then \
 	    $(top_srcdir)/build-aux/dist-error $(info_file_dist); \

http://git-wip-us.apache.org/repos/asf/couchdb/blob/3c0e87e9/share/doc/src/conf.py
----------------------------------------------------------------------
diff --git a/share/doc/src/conf.py b/share/doc/src/conf.py
index 7c9e56f..ff5ba43 100644
--- a/share/doc/src/conf.py
+++ b/share/doc/src/conf.py
@@ -10,8 +10,6 @@
 ## License for the specific language governing permissions and limitations under
 ## the License.
 
-# http://sphinx.pocoo.org/config.html
-
 import sys, os
 
 extensions = ["sphinx.ext.todo"]
@@ -22,75 +20,46 @@ master_doc = "index"
 
 nitpicky = True
 
-# CouchDB ##############################################################
-# These will be over-ridden during make dist but are listed here
-# to ensure that the readthedocs.org build has version numbers present
-# The short X.Y version.
-#version = "@@"
-version = "latest"
-# The full version, including alpha/beta/rc tags.
-# release = None
-#release = "@@"
-release = "latest"
+version = "1.3"
+
+release = "1.3.0"
 
-#project = "@@"
-project = u'Apache CouchDB'
+project = u"Apache CouchDB"
 
-#copyright = "@@"
-copyright = u'2012, Apache Software Foundation'
+copyright = u"2012, The Apache Software Foundation"
 
 highlight_language = "json"
 
 pygments_style = "sphinx"
 
-# @@ design CouchDB theme
-# @@ http://jinja.pocoo.org/docs/ looks nice
-
 html_theme = "default"
 
-# inherit from project title
-#html_short_title = "@@"
-
-html_logo = ""
+html_logo = "" # @@ waiting on logo
 
-html_favicon = ""
-
-html_use_opensearch = ""
-
-html_add_permalinks = True
+html_favicon = "../images/favicon.ico"
 
 text_newlines = "native"
 
-# use this for excluding docs from final build
-# unused_docs = ["src/tmp/*.rst"]
-
 latex_documents = [(
        "index",
        "CouchDB.tex",
-       "",
+       project,
        "",
        "manual",
        True
 )]
 
-# latex_paper_size = 'a4paper'
-
 latex_elements = {
-    'papersize':'a4paper'
-    }
+    "papersize":"a4paper"
+}
 
 texinfo_documents = [(
        "index",
        "CouchDB",
+       project,
        "",
-       "",
-       "dir_entry",
-       "description",
-       "category",
-       "manual",
+       "CouchDB",
+       "The Apache CouchDB database",
+       "Databases",
        True
 )]
-
-rst_epilog = """
-.. |psf| replace:: Apache Software Foundation
-"""
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/couchdb/blob/3c0e87e9/share/doc/src/index.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/index.rst b/share/doc/src/index.rst
index b7591d3..c0984fc 100644
--- a/share/doc/src/index.rst
+++ b/share/doc/src/index.rst
@@ -10,16 +10,20 @@
 .. License for the specific language governing permissions and limitations under
 .. the License.
 
-.. CouchDB documentation master file, created by
-   sphinx-quickstart on Tue Jul 31 20:52:16 2012.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
 Apache CouchDB Documentation
 ============================
 
-Contents:
+`Apache CouchDB™ <http://couchdb.apache.org/>`_ 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
+would like to help with that, please subscribe to the `developer mailing list
+<http://couchdb.apache.org/#mailing-list>`_ and give a shout.
 
+Contents
+========
+   
 .. toctree::
     :maxdepth: 2
 
@@ -40,10 +44,3 @@ Contents:
     release
     api/reference
     json-structure
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`


Mime
View raw message