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/12/01 19:37:56 UTC
git commit: Fixed build
Updated Branches:
refs/heads/docs 18248b18f -> 6554bfdae
Fixed build
Project: http://git-wip-us.apache.org/repos/asf/couchdb/repo
Commit: http://git-wip-us.apache.org/repos/asf/couchdb/commit/6554bfda
Tree: http://git-wip-us.apache.org/repos/asf/couchdb/tree/6554bfda
Diff: http://git-wip-us.apache.org/repos/asf/couchdb/diff/6554bfda
Branch: refs/heads/docs
Commit: 6554bfdae3cb96e17ac49362b4cf0143af5b7220
Parents: 18248b1
Author: Noah Slater <ns...@apache.org>
Authored: Sat Dec 1 18:37:48 2012 +0000
Committer: Noah Slater <ns...@apache.org>
Committed: Sat Dec 1 18:37:48 2012 +0000
----------------------------------------------------------------------
license.skip | 1 +
share/doc/build/Makefile.am | 21 ++--
share/doc/make.bat | 202 ---------------------------------
share/doc/src/conf.py | 6 +-
share/doc/templates/sidebar.html | 15 +++
5 files changed, 32 insertions(+), 213 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/couchdb/blob/6554bfda/license.skip
----------------------------------------------------------------------
diff --git a/license.skip b/license.skip
index d813a2c..98c0c78 100644
--- a/license.skip
+++ b/license.skip
@@ -60,6 +60,7 @@
^share/doc/Makefile.in
^share/doc/build/.*
^share/doc/images/.*
+^share/doc/static/rtd.css
^share/server/json2.js
^share/server/mimeparse.js
^share/server/coffee-script.js
http://git-wip-us.apache.org/repos/asf/couchdb/blob/6554bfda/share/doc/build/Makefile.am
----------------------------------------------------------------------
diff --git a/share/doc/build/Makefile.am b/share/doc/build/Makefile.am
index 60c1757..f873df3 100644
--- a/share/doc/build/Makefile.am
+++ b/share/doc/build/Makefile.am
@@ -50,11 +50,14 @@ html_files = \
html/_static/doctools.js \
html/_static/down-pressed.png \
html/_static/down.png \
+ html/_static/favicon.ico \
html/_static/file.png \
html/_static/jquery.js \
+ html/_static/logo.png \
html/_static/minus.png \
html/_static/plus.png \
html/_static/pygments.css \
+ html/_static/rtd.css \
html/_static/searchtools.js \
html/_static/sidebar.js \
html/_static/underscore.js \
@@ -94,18 +97,20 @@ html_files = \
html/ssl.html
if BUILD_HTML
-html_file_build = $(html_files)
+html_files_build = $(html_files)
else
-html_file_build =
+html_files_build =
endif
image_files = \
../images/epub-icon.png \
+ ../images/favicon.ico \
../images/futon-createdb.png \
../images/futon-editdoc.png \
../images/futon-editeddoc.png \
../images/futon-overview.png \
- ../images/futon-replform.png
+ ../images/futon-replform.png \
+ ../images/logo.png
src_files = \
../src/api/authn.rst \
@@ -120,6 +125,7 @@ src_files = \
../src/api-basics.rst \
../src/changes.rst \
../src/commonjs.rst \
+ ../src/conf.py \
../src/config_reference.rst \
../src/configuring.rst \
../src/ddocs.rst \
@@ -134,13 +140,11 @@ src_files = \
../src/pretty_urls.rst \
../src/release.rst \
../src/replication.rst \
- ../src/ssl.rst
+ ../src/ssl.rst \
+ ../static/rtd.css \
+ ../templates/sidebar.html
EXTRA_DIST = \
- ../src/conf.py \
- ../demo.mk \
- ../make.bat \
- ../Makefile.am \
$(image_files) \
$(src_files) \
$(info_file_build) \
@@ -196,6 +200,7 @@ $(html_files): html.stamp
html.stamp: $(image_files) $(src_files)
@rm -f html.tmp
@touch html.tmp
+ pwd
$(top_srcdir)/build-aux/sphinx-build \
-b html $(SPHINXOPTS) $(builddir)/html
$(top_srcdir)/build-aux/sphinx-touch $(html_files)
http://git-wip-us.apache.org/repos/asf/couchdb/blob/6554bfda/share/doc/make.bat
----------------------------------------------------------------------
diff --git a/share/doc/make.bat b/share/doc/make.bat
deleted file mode 100644
index bf354c9..0000000
--- a/share/doc/make.bat
+++ /dev/null
@@ -1,202 +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.
-
-@ECHO OFF
-
-REM Command file for Sphinx documentation
-
-if "%SPHINXBUILD%" == "" (
- set SPHINXBUILD=sphinx-build
-)
-set BUILDDIR=build
-set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% source
-set I18NSPHINXOPTS=%SPHINXOPTS% source
-if NOT "%PAPER%" == "" (
- set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
- set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
-)
-
-if "%1" == "" goto help
-
-if "%1" == "help" (
- :help
- echo.Please use `make ^<target^>` where ^<target^> is one of
- echo. html to make standalone HTML files
- echo. dirhtml to make HTML files named index.html in directories
- echo. singlehtml to make a single large HTML file
- echo. pickle to make pickle files
- echo. json to make JSON files
- echo. htmlhelp to make HTML files and a HTML help project
- echo. qthelp to make HTML files and a qthelp project
- echo. devhelp to make HTML files and a Devhelp project
- echo. epub to make an epub
- echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
- echo. text to make text files
- echo. man to make manual pages
- echo. texinfo to make Texinfo files
- echo. gettext to make PO message catalogs
- echo. changes to make an overview over all changed/added/deprecated items
- echo. linkcheck to check all external links for integrity
- echo. doctest to run all doctests embedded in the documentation if enabled
- goto end
-)
-
-if "%1" == "clean" (
- for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
- del /q /s %BUILDDIR%\*
- goto end
-)
-
-if "%1" == "html" (
- %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
- if errorlevel 1 exit /b 1
- echo.
- echo.Build finished. The HTML pages are in %BUILDDIR%/html.
- goto end
-)
-
-if "%1" == "dirhtml" (
- %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
- if errorlevel 1 exit /b 1
- echo.
- echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
- goto end
-)
-
-if "%1" == "singlehtml" (
- %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
- if errorlevel 1 exit /b 1
- echo.
- echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
- goto end
-)
-
-if "%1" == "pickle" (
- %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
- if errorlevel 1 exit /b 1
- echo.
- echo.Build finished; now you can process the pickle files.
- goto end
-)
-
-if "%1" == "json" (
- %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
- if errorlevel 1 exit /b 1
- echo.
- echo.Build finished; now you can process the JSON files.
- goto end
-)
-
-if "%1" == "htmlhelp" (
- %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
- if errorlevel 1 exit /b 1
- echo.
- echo.Build finished; now you can run HTML Help Workshop with the ^
-.hhp project file in %BUILDDIR%/htmlhelp.
- goto end
-)
-
-if "%1" == "qthelp" (
- %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
- if errorlevel 1 exit /b 1
- echo.
- echo.Build finished; now you can run "qcollectiongenerator" with the ^
-.qhcp project file in %BUILDDIR%/qthelp, like this:
- echo.^> qcollectiongenerator %BUILDDIR%\qthelp\CouchDB.qhcp
- echo.To view the help file:
- echo.^> assistant -collectionFile %BUILDDIR%\qthelp\CouchDB.ghc
- goto end
-)
-
-if "%1" == "devhelp" (
- %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
- if errorlevel 1 exit /b 1
- echo.
- echo.Build finished.
- goto end
-)
-
-if "%1" == "epub" (
- %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
- if errorlevel 1 exit /b 1
- echo.
- echo.Build finished. The epub file is in %BUILDDIR%/epub.
- goto end
-)
-
-if "%1" == "latex" (
- %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
- if errorlevel 1 exit /b 1
- echo.
- echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
- goto end
-)
-
-if "%1" == "text" (
- %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
- if errorlevel 1 exit /b 1
- echo.
- echo.Build finished. The text files are in %BUILDDIR%/text.
- goto end
-)
-
-if "%1" == "man" (
- %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
- if errorlevel 1 exit /b 1
- echo.
- echo.Build finished. The manual pages are in %BUILDDIR%/man.
- goto end
-)
-
-if "%1" == "texinfo" (
- %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
- if errorlevel 1 exit /b 1
- echo.
- echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
- goto end
-)
-
-if "%1" == "gettext" (
- %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
- if errorlevel 1 exit /b 1
- echo.
- echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
- goto end
-)
-
-if "%1" == "changes" (
- %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
- if errorlevel 1 exit /b 1
- echo.
- echo.The overview file is in %BUILDDIR%/changes.
- goto end
-)
-
-if "%1" == "linkcheck" (
- %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
- if errorlevel 1 exit /b 1
- echo.
- echo.Link check complete; look for any errors in the above output ^
-or in %BUILDDIR%/linkcheck/output.txt.
- goto end
-)
-
-if "%1" == "doctest" (
- %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
- if errorlevel 1 exit /b 1
- echo.
- echo.Testing of doctests in the sources finished, look at the ^
-results in %BUILDDIR%/doctest/output.txt.
- goto end
-)
-
-:end
http://git-wip-us.apache.org/repos/asf/couchdb/blob/6554bfda/share/doc/src/conf.py
----------------------------------------------------------------------
diff --git a/share/doc/src/conf.py b/share/doc/src/conf.py
index e765a9d..56d9dc2 100644
--- a/share/doc/src/conf.py
+++ b/share/doc/src/conf.py
@@ -32,10 +32,10 @@ highlight_language = "json"
pygments_style = "sphinx"
-templates_path = ["../templates"]
-
html_theme = "default"
+templates_path = ["../templates"]
+
html_static_path = ["../static"]
html_style = "rtd.css"
@@ -48,7 +48,7 @@ html_sidebars= {
"**": [
"localtoc.html",
"relations.html",
- "../templates/sidebar.html",
+ "sidebar.html",
]
}
http://git-wip-us.apache.org/repos/asf/couchdb/blob/6554bfda/share/doc/templates/sidebar.html
----------------------------------------------------------------------
diff --git a/share/doc/templates/sidebar.html b/share/doc/templates/sidebar.html
index 4fdea02..67b0e50 100644
--- a/share/doc/templates/sidebar.html
+++ b/share/doc/templates/sidebar.html
@@ -1,3 +1,18 @@
+<!--
+
+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.
+
+-->
+
<h3>More Help</h3>
<ul>