You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@couchdb.apache.org by dc...@apache.org on 2012/11/19 21:23:17 UTC
[2/3] git commit: fix various sphinx warnings
fix various sphinx warnings
- hook in readthedocs.org compatibility with makefiles
- include empty dir _static to suppress warning for missing directory
- fix sphinx paragraph warnings under readtthedocs configuration
- missing .rst file from stamp list
Project: http://git-wip-us.apache.org/repos/asf/couchdb/repo
Commit: http://git-wip-us.apache.org/repos/asf/couchdb/commit/c215b45c
Tree: http://git-wip-us.apache.org/repos/asf/couchdb/tree/c215b45c
Diff: http://git-wip-us.apache.org/repos/asf/couchdb/diff/c215b45c
Branch: refs/heads/docs
Commit: c215b45c4b7f166ecac89d36a2bb4de5c9f184ff
Parents: d9ab902
Author: Dave Cottlehuber <dc...@apache.org>
Authored: Mon Nov 19 01:13:59 2012 +0100
Committer: Dave Cottlehuber <dc...@apache.org>
Committed: Mon Nov 19 21:21:42 2012 +0100
----------------------------------------------------------------------
share/doc/build/Makefile.am | 8 ++-
share/doc/conf.py | 94 ----------------------------------
share/doc/src/conf.py | 94 ++++++++++++++++++++++++++++++++++
share/doc/src/query-servers.rst | 1 +
4 files changed, 100 insertions(+), 97 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/couchdb/blob/c215b45c/share/doc/build/Makefile.am
----------------------------------------------------------------------
diff --git a/share/doc/build/Makefile.am b/share/doc/build/Makefile.am
index 6044392..da44634 100644
--- a/share/doc/build/Makefile.am
+++ b/share/doc/build/Makefile.am
@@ -38,7 +38,7 @@
SPHINXOPTS = \
-d doctrees \
- -n -c $(srcdir)/.. \
+ -n -c $(srcdir)/../src \
$(srcdir)/../src
# -----------------------------------------------------------------------------
@@ -75,6 +75,7 @@ html_files = \
html/_sources/index.txt \
html/_sources/intro.txt \
html/_sources/json-structure.txt \
+ html/_sources/query-servers.rst \
html/_sources/os-daemons.txt \
html/_sources/range.txt \
html/_sources/release.txt \
@@ -121,6 +122,7 @@ html_files = \
html/index.html \
html/intro.html \
html/json-structure.html \
+ html/query-servers.html \
html/objects.inv \
html/os-daemons.html \
html/range.html \
@@ -159,8 +161,8 @@ src_files = \
../src/index.rst \
../src/intro.rst \
../src/json-structure.rst \
+ ../src/query-servers.rst \
../src/os-daemons.rst \
- ../query-servers.rst \
../src/range.rst \
../src/release.rst \
../src/replication.rst \
@@ -173,7 +175,7 @@ dist_localdoc_DATA = \
nobase_dist_localdoc_DATA = $(html_files)
EXTRA_DIST = \
- ../conf.py \
+ ../src/conf.py \
../demo.mk \
../make.bat \
../Makefile.am \
http://git-wip-us.apache.org/repos/asf/couchdb/blob/c215b45c/share/doc/conf.py
----------------------------------------------------------------------
diff --git a/share/doc/conf.py b/share/doc/conf.py
deleted file mode 100644
index ddbaf14..0000000
--- a/share/doc/conf.py
+++ /dev/null
@@ -1,94 +0,0 @@
-## Licensed under the Apache License, Version 2.0 (the "License"); you may not
-## use this file except in compliance with the License. You may obtain a copy of
-## the License at
-##
-## http://www.apache.org/licenses/LICENSE-2.0
-##
-## Unless required by applicable law or agreed to in writing, software
-## distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
-## WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
-## 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"]
-
-source_suffix = ".rst"
-
-master_doc = "src/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"
-
-#project = "@@"
-project = u'Apache CouchDB'
-
-#copyright = "@@"
-copyright = u'2012, 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_favicon = ""
-
-html_use_opensearch = ""
-
-html_add_permalinks = True
-
-text_newlines = "native"
-
-# 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
-# )]
-
-rst_epilog = """
-.. |psf| replace:: Apache Software Foundation
-"""
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/couchdb/blob/c215b45c/share/doc/src/_static/.gitignore
----------------------------------------------------------------------
diff --git a/share/doc/src/_static/.gitignore b/share/doc/src/_static/.gitignore
new file mode 100644
index 0000000..e69de29
http://git-wip-us.apache.org/repos/asf/couchdb/blob/c215b45c/share/doc/src/conf.py
----------------------------------------------------------------------
diff --git a/share/doc/src/conf.py b/share/doc/src/conf.py
new file mode 100644
index 0000000..4f2db47
--- /dev/null
+++ b/share/doc/src/conf.py
@@ -0,0 +1,94 @@
+## Licensed under the Apache License, Version 2.0 (the "License"); you may not
+## use this file except in compliance with the License. You may obtain a copy of
+## the License at
+##
+## http://www.apache.org/licenses/LICENSE-2.0
+##
+## Unless required by applicable law or agreed to in writing, software
+## distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+## WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+## 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"]
+
+source_suffix = ".rst"
+
+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"
+
+#project = "@@"
+project = u'Apache CouchDB'
+
+#copyright = "@@"
+copyright = u'2012, 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_favicon = ""
+
+html_use_opensearch = ""
+
+html_add_permalinks = True
+
+text_newlines = "native"
+
+# 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
+# )]
+
+rst_epilog = """
+.. |psf| replace:: Apache Software Foundation
+"""
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/couchdb/blob/c215b45c/share/doc/src/query-servers.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/query-servers.rst b/share/doc/src/query-servers.rst
index c6f3a74..e77abd7 100644
--- a/share/doc/src/query-servers.rst
+++ b/share/doc/src/query-servers.rst
@@ -198,6 +198,7 @@ modules and functions:
For `list`-functions only!
.. note::
+
Only at this point list functions may set response `HTTP code` and
`headers`. Also, you need to run this function before :func:`send`,
:func:`getRow` or `return` statement or query server will implicitly call