You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@couchdb.apache.org by ns...@apache.org on 2012/10/06 14:21:54 UTC

git commit: Some more work on PDF and now info generation

Updated Branches:
  refs/heads/docs 5f56a4813 -> 607ebab25


Some more work on PDF and now info generation


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

Branch: refs/heads/docs
Commit: 607ebab25a9d1174e4786c21bca562ec2a631fc2
Parents: 5f56a48
Author: Noah Slater <ns...@apache.org>
Authored: Sat Oct 6 13:21:48 2012 +0100
Committer: Noah Slater <ns...@apache.org>
Committed: Sat Oct 6 13:21:48 2012 +0100

----------------------------------------------------------------------
 .gitignore                  |    1 +
 share/doc/Makefile.am       |    4 --
 share/doc/build/Makefile.am |   57 ++++++++++++++++++++++++++++++++++++--
 share/doc/src/conf.py       |    4 ++-
 4 files changed, 58 insertions(+), 8 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/couchdb/blob/607ebab2/.gitignore
----------------------------------------------------------------------
diff --git a/.gitignore b/.gitignore
index 74abff9..45f92d0 100644
--- a/.gitignore
+++ b/.gitignore
@@ -44,6 +44,7 @@ libtool
 share/doc/build/doctrees
 share/doc/build/html
 share/doc/build/latex
+share/doc/build/text
 share/server/main-coffee.js
 share/server/main.js
 src/couch_mrview/ebin/

http://git-wip-us.apache.org/repos/asf/couchdb/blob/607ebab2/share/doc/Makefile.am
----------------------------------------------------------------------
diff --git a/share/doc/Makefile.am b/share/doc/Makefile.am
index 60f3e82..9f432f9 100644
--- a/share/doc/Makefile.am
+++ b/share/doc/Makefile.am
@@ -12,10 +12,6 @@
 
 SUBDIRS = build
 
-# @@ can we remove _static?
-
-# @@ what is the license for conf.py?
-
 EXTRA_DIST = \
 	demo.mk \
 	images/epub-icon.png \

http://git-wip-us.apache.org/repos/asf/couchdb/blob/607ebab2/share/doc/build/Makefile.am
----------------------------------------------------------------------
diff --git a/share/doc/build/Makefile.am b/share/doc/build/Makefile.am
index 63895da..c205bb1 100644
--- a/share/doc/build/Makefile.am
+++ b/share/doc/build/Makefile.am
@@ -110,9 +110,38 @@ html_files = \
     html/searchindex.js \
     html/ssl.html
 
-pdf_files = latex/manual.pdf.gz
-
-nobase_dist_localdoc_DATA = $(html_files)
+pdf_files = latex/CouchDB.pdf.gz
+
+text_files = \
+    api/authn.txt \
+    api/configuration.txt \
+    api/database.txt \
+    api/dbmaint.txt \
+    api/design.txt \
+    api/documents.txt \
+    api/local.txt \
+    api/misc.txt \
+    api/reference.txt \
+    api-basics.txt \
+    changes.txt \
+    commonjs.txt \
+    config_reference.txt \
+    configuring.txt \
+    ddocs.txt \
+    errors.txt \
+    http-proxying.txt \
+    index.txt \
+    intro.txt \
+    json-structure.txt \
+    os-daemons.txt \
+    range.txt \
+    release.txt \
+    replication.txt \
+    ssl.txt \
+
+nobase_dist_localdoc_DATA = \
+	$(html_files) \
+	$(text_files) \
 
 dist_localdoc_DATA = $(pdf_files)
 
@@ -123,6 +152,10 @@ $(pdf_files): sphinx-pdf
 # @@ convert both targets to use stamp files
 # http://www.gnu.org/software/automake/manual/html_node/Multiple-Outputs.html
 
+# @@ move conf.py and use and set variables
+
+# @@ figure out if we should distribute the PDF in the dist dir
+
 # @@ seems to get called twice during the build
 .PHONY: sphinx-html
 sphinx-html: ../src/_static
@@ -134,6 +167,15 @@ sphinx-pdf:
 	$(MAKE) -C latex all-pdf
 	-gzip -9 < latex/CouchDB.pdf > latex/CouchDB.pdf.gz
 
+.PHONY: sphinx-text
+sphinx-text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) text
+
+.PHONY: sphinx-info
+sphinx-info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) texinfo
+	make -C texinfo info
+
 # @@ figure out how to remove this _static dir
 ../src/_static:
 	mkdir -p $@
@@ -147,3 +189,12 @@ maintainer-clean-local:
 	rm -fr doctrees
 	rm -fr html
 	rm -fr latex
+
+# @@ can we remove _static?
+
+# @@ what is the license for conf.py?
+
+# @@ need to explicitly put the license in the readable part of the doc
+
+# @@ tweak conf.py
+# http://sphinx.pocoo.org/config.html

http://git-wip-us.apache.org/repos/asf/couchdb/blob/607ebab2/share/doc/src/conf.py
----------------------------------------------------------------------
diff --git a/share/doc/src/conf.py b/share/doc/src/conf.py
index 140ee42..7199dde 100644
--- a/share/doc/src/conf.py
+++ b/share/doc/src/conf.py
@@ -55,4 +55,6 @@ latex_documents = [(
 	"",
 	"manual",
 	True
-)]
\ No newline at end of file
+)]
+
+text_newlines = "native"