couchdb-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From d..@apache.org
Subject [6/6] git commit: fixing readthedocs.org auto-generation
Date Sun, 18 Nov 2012 19:19:39 GMT
fixing readthedocs.org auto-generation


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

Branch: refs/heads/docs
Commit: d1d0016d02deccb840cea769f76b93d802770b5a
Parents: 7723efc
Author: Dave Cottlehuber <dch@apache.org>
Authored: Fri Nov 2 21:50:38 2012 +0100
Committer: Dave Cottlehuber <dch@apache.org>
Committed: Sun Nov 18 20:15:20 2012 +0100

----------------------------------------------------------------------
 share/doc/conf.py |   78 +++++++++++++++++++++++++++--------------------
 1 files changed, 45 insertions(+), 33 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/couchdb/blob/d1d0016d/share/doc/conf.py
----------------------------------------------------------------------
diff --git a/share/doc/conf.py b/share/doc/conf.py
index 8602ab9..4787c6c 100644
--- a/share/doc/conf.py
+++ b/share/doc/conf.py
@@ -18,29 +18,38 @@ extensions = ["sphinx.ext.todo"]
 
 source_suffix = ".rst"
 
-master_doc = "index"
+master_doc = "src/index"
 
 nitpicky = True
 
-project = "@@"
+# 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"
 
-copyright = "@@"
+#project = "@@"
+project = u'Apache CouchDB'
 
-version = "@@"
-
-release = "@@"
+#copyright = "@@"
+copyright = u'2012, Apache Software Foundation'
 
 highlight_language = "json"
 
 pygments_style = "sphinx"
 
 # @@ design CouchDB theme
-
-# @@ check out http://sphinx.pocoo.org/theming.html
+# @@ http://jinja.pocoo.org/docs/ looks nice
 
 html_theme = "default"
 
-html_short_title = "@@"
+# inherit from project title
+#html_short_title = "@@"
 
 html_logo = ""
 
@@ -50,27 +59,30 @@ html_use_opensearch = ""
 
 text_newlines = "native"
 
-latex_documents = [(
-	"index",
-	"CouchDB.tex",
-	"",
-	"",
-	"manual",
-	True
-)]
-
-#latex_elements[(
-#	"a4paper" # @@ do we want this?
-#)]
-
-texinfo_documents = [(
-	"index",
-	"CouchDB",
-	"",
-	"",
-	"dir_entry",
-	"description",
-	"category",
-	"manual",
-	True
-)]
+# use this for excluding docs from final build
+# unused_docs = ["src/tmp/*.rst"]
+
+# latex_documents = [(
+# 	"index",
+# 	"CouchDB.tex",
+# 	"",
+# 	"",
+# 	"manual",
+# 	True
+# )]
+
+# #latex_elements[(
+# #	"a4paper" # @@ do we want this?
+# #)]
+
+# texinfo_documents = [(
+# 	"index",
+# 	"CouchDB",
+# 	"",
+# 	"",
+# 	"dir_entry",
+# 	"description",
+# 	"category",
+# 	"manual",
+# 	True
+# )]


Mime
View raw message