[Groonga-commit] groonga/groonga [master] make generated HTML installable.

Back to archive index

null+****@clear***** null+****@clear*****
2010年 8月 20日 (金) 16:52:17 JST


Kouhei Sutou	2010-08-20 07:52:17 +0000 (Fri, 20 Aug 2010)

  New Revision: d1402c1e91f12a77f73ae7a8ffb41022a178e84d

  Log:
    make generated HTML installable.

  Added files:
    doc/Makefile.am
    doc/ja/Makefile.am
    doc/ja/build/Makefile.am
  Removed files:
    doc/ja/Makefile
  Modified files:
    .gitignore
    Makefile.am
    configure.ac

  Modified: .gitignore (+3 -4)
===================================================================
--- .gitignore    2010-08-20 07:19:34 +0000 (0573baa)
+++ .gitignore    2010-08-20 07:52:17 +0000 (58de8b2)
@@ -37,10 +37,9 @@ Makefile.in
 version.sh
 /examples/kv
 /examples/index
-/doc/ja/.buildinfo
-/doc/ja/_sources/
-/doc/ja/_static/
-/doc/ja/build/
+/doc/ja/build/doctrees/
+/doc/ja/build/html/
+/doc/ja/build/rdoc/
 /doc/ja/modindex.html
 /doc/ja/objects.inv
 /lib/icudump

  Modified: Makefile.am (+2 -10)
===================================================================
--- Makefile.am    2010-08-20 07:19:34 +0000 (11aa837)
+++ Makefile.am    2010-08-20 07:52:17 +0000 (9d92295)
@@ -1,7 +1,7 @@
 AUTOMAKE_OPTIONS = 1.9.7
-SUBDIRS = lib modules src examples test apt data resource
+SUBDIRS = lib modules src examples test apt data resource doc
 #dist_data_DATA =
-EXTRA_DIST = bindings doc/ja version-gen.sh
+EXTRA_DIST = bindings version-gen.sh
 pkginclude_HEADERS = groonga.h
 
 pkgconfigdir = $(libdir)/pkgconfig
@@ -15,14 +15,6 @@ version.sh: FORCE
 @am__inclu****@versi*****
 
 dist-hook:
-	rm -rf `find $(distdir) -name '*.loT'`
-	rm -rf `find $(distdir) -name '*.cache'`
-	rm -rf `find $(distdir) -name '*.bak'`
-	rm -rf `find $(distdir) -name '*.orig'`
-	find $(distdir)/doc/ja -type f | grep -Ev "/(README|.+\.(rd|js|html|css|png))$$" | xargs rm -f
-	rm -rf $(distdir)/doc/ja/_sources
-	rm -rf $(distdir)/doc/ja/build
-	rm -rf $(distdir)/doc/ja/source
 	echo "$(GROONGA_VERSION)" > $(distdir)/version
 
 benchmark:

  Modified: configure.ac (+3 -0)
===================================================================
--- configure.ac    2010-08-20 07:19:34 +0000 (999fcd7)
+++ configure.ac    2010-08-20 07:52:17 +0000 (10877f9)
@@ -97,6 +97,9 @@ AC_CONFIG_FILES([Makefile
                  data/Makefile
                  data/munin/Makefile
                  resource/Makefile
+                 doc/Makefile
+                 doc/ja/Makefile
+                 doc/ja/build/Makefile
                  test/Makefile
                  test/unit/Makefile
                  test/unit/lib/Makefile

  Added: doc/Makefile.am (+1 -0) 100644
===================================================================
--- /dev/null
+++ doc/Makefile.am    2010-08-20 07:52:17 +0000 (38057c6)
@@ -0,0 +1 @@
+SUBDIRS = ja

  Deleted: doc/ja/Makefile (+0 -105) 100644
===================================================================
--- doc/ja/Makefile    2010-08-20 07:19:34 +0000 (b8ecc71)
+++ /dev/null
@@ -1,105 +0,0 @@
-# Makefile for Sphinx documentation
-#
-
-# You can set these variables from the command line.
-SPHINXOPTS    =
-SPHINXBUILD   = sphinx-build
-PAPER         =
-BUILDDIR      = build
-
-# Internal variables.
-PAPEROPT_a4     = -D latex_paper_size=a4
-PAPEROPT_letter = -D latex_paper_size=letter
-ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
-
-.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
-
-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 "  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 "  latex     to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
-	@echo "  rdoc      to make RDoc files"
-	@echo "  changes   to make an overview of 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)"
-
-clean:
-	-rm -rf $(BUILDDIR)/*
-
-man:
-	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
-	@echo
-	@echo "Build finished. The man pages are in $(BUILDDIR)/man."
-
-html:
-	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
-	@echo
-	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
-
-dirhtml:
-	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
-	@echo
-	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
-
-pickle:
-	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
-	@echo
-	@echo "Build finished; now you can process the pickle files."
-
-json:
-	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
-	@echo
-	@echo "Build finished; now you can process the JSON files."
-
-htmlhelp:
-	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
-	@echo
-	@echo "Build finished; now you can run HTML Help Workshop with the" \
-	      ".hhp project file in $(BUILDDIR)/htmlhelp."
-
-qthelp:
-	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
-	@echo
-	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
-	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
-	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/groonga.qhcp"
-	@echo "To view the help file:"
-	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/groonga.qhc"
-
-latex:
-	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
-	@echo
-	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
-	@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
-	      "run these through (pdf)latex."
-
-rdoc:
-	$(SPHINXBUILD) -b rdoc $(ALLSPHINXOPTS) $(BUILDDIR)/rdoc
-	@echo
-	@echo "Build finished; the RDoc files are in $(BUILDDIR)/rdoc."
-
-changes:
-	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
-	@echo
-	@echo "The overview file is in $(BUILDDIR)/changes."
-
-linkcheck:
-	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
-	@echo
-	@echo "Link check complete; look for any errors in the above output " \
-	      "or in $(BUILDDIR)/linkcheck/output.txt."
-
-doctest:
-	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
-	@echo "Testing of doctests in the sources finished, look at the " \
-	      "results in $(BUILDDIR)/doctest/output.txt."
-
-pdf:
-	$(SPHINXBUILD) -b pdf $(ALLSPHINXOPTS) $(BUILDDIR)/pdf
-	@echo
-	@echo "Build finished. The PDF files are in $(BUILDDIR)/pdf."

  Added: doc/ja/Makefile.am (+233 -0) 100644
===================================================================
--- /dev/null
+++ doc/ja/Makefile.am    2010-08-20 07:52:17 +0000 (581f6f1)
@@ -0,0 +1,233 @@
+SUBDIRS = $(BUILDDIR)
+
+docdir = $(pkgdatadir)/doc
+doc_jadir = $(docdir)/ja
+
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = build
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+
+.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  man       to make man files"
+	@echo "  html      to make standalone HTML files"
+	@echo "  dirhtml   to make HTML files named index.html in directories"
+	@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 "  latex     to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  rdoc      to make RDoc files"
+	@echo "  changes   to make an overview of 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)"
+
+clean:
+	-rm -rf $(BUILDDIR)/*
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The man pages are in $(BUILDDIR)/man."
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/groonga.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/groonga.qhc"
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
+	      "run these through (pdf)latex."
+
+rdoc:
+	$(SPHINXBUILD) -b rdoc $(ALLSPHINXOPTS) $(BUILDDIR)/rdoc
+	@echo
+	@echo "Build finished; the RDoc files are in $(BUILDDIR)/rdoc."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."
+
+pdf:
+	$(SPHINXBUILD) -b pdf $(ALLSPHINXOPTS) $(BUILDDIR)/pdf
+	@echo
+	@echo "Build finished. The PDF files are in $(BUILDDIR)/pdf."
+
+# find source -type f -not -name '*.pyc' | sort | sed -e 's,^,\t,g'
+nobase_dist_doc_ja_DATA =			\
+	source/__init__.py			\
+	source/characteristic.txt		\
+	source/commands.txt			\
+	source/commands/cache_limit.txt		\
+	source/commands/check.txt		\
+	source/commands/clearlock.txt		\
+	source/commands/column_create.txt	\
+	source/commands/column_list.txt		\
+	source/commands/column_remove.txt	\
+	source/commands/define_selector.txt	\
+	source/commands/defrag.txt		\
+	source/commands/delete.txt		\
+	source/commands/dump.txt		\
+	source/commands/load.txt		\
+	source/commands/log_level.txt		\
+	source/commands/log_put.txt		\
+	source/commands/log_reopen.txt		\
+	source/commands/quit.txt		\
+	source/commands/select.txt		\
+	source/commands/shutdown.txt		\
+	source/commands/status.txt		\
+	source/commands/table_create.txt	\
+	source/commands/table_list.txt		\
+	source/commands/table_remove.txt	\
+	source/commands/view_add.txt		\
+	source/commands_not_implemented/add.txt	\
+	source/commands_not_implemented/get.txt	\
+	source/commands_not_implemented/set.txt	\
+	source/conf.py				\
+	source/developer.txt			\
+	source/developer/com.txt		\
+	source/developer/document.txt		\
+	source/developer/query.txt		\
+	source/developer/test.txt		\
+	source/example/tutorial01-1.log		\
+	source/example/tutorial01-10.log	\
+	source/example/tutorial01-11.log	\
+	source/example/tutorial01-12.log	\
+	source/example/tutorial01-13.log	\
+	source/example/tutorial01-14.log	\
+	source/example/tutorial01-15.log	\
+	source/example/tutorial01-16.log	\
+	source/example/tutorial01-17.log	\
+	source/example/tutorial01-2.log		\
+	source/example/tutorial01-3.log		\
+	source/example/tutorial01-4.log		\
+	source/example/tutorial01-5.log		\
+	source/example/tutorial01-6.log		\
+	source/example/tutorial01-7.log		\
+	source/example/tutorial01-8.log		\
+	source/example/tutorial01-9.log		\
+	source/example/tutorial02-1.log		\
+	source/example/tutorial02-2.log		\
+	source/example/tutorial02-3.log		\
+	source/example/tutorial03-1.log		\
+	source/example/tutorial03-2.log		\
+	source/example/tutorial03-3.log		\
+	source/example/tutorial04-1.log		\
+	source/example/tutorial04-2.log		\
+	source/example/tutorial04-3.log		\
+	source/example/tutorial04-4.log		\
+	source/example/tutorial04-5.log		\
+	source/example/tutorial04-6.log		\
+	source/example/tutorial04-7.log		\
+	source/example/tutorial05-1.log		\
+	source/example/tutorial05-2.log		\
+	source/example/tutorial05-3.log		\
+	source/example/tutorial05-4.log		\
+	source/example/tutorial05-5.log		\
+	source/example/tutorial05-6.log		\
+	source/example/tutorial06-1.log		\
+	source/example/tutorial06-2.log		\
+	source/example/tutorial06-3.log		\
+	source/example/tutorial06-4.log		\
+	source/example/tutorial06-5.log		\
+	source/example/tutorial07-1.log		\
+	source/example/tutorial07-2.log		\
+	source/example/tutorial07-3.log		\
+	source/example/tutorial07-4.log		\
+	source/example/tutorial08-1.log		\
+	source/example/tutorial10-1.log		\
+	source/example/tutorial10-10.log	\
+	source/example/tutorial10-2.log		\
+	source/example/tutorial10-3.log		\
+	source/example/tutorial10-4.log		\
+	source/example/tutorial10-5.log		\
+	source/example/tutorial10-6.log		\
+	source/example/tutorial10-7.log		\
+	source/example/tutorial10-8.log		\
+	source/example/tutorial10-9.log		\
+	source/execfile.txt			\
+	source/expr.txt				\
+	source/functions.txt			\
+	source/functions/geo_distance.txt	\
+	source/functions/geo_in_circle.txt	\
+	source/functions/geo_in_rectangle.txt	\
+	source/functions/now.txt		\
+	source/functions/rand.txt		\
+	source/grnslap.txt			\
+	source/grntest.txt			\
+	source/http.txt				\
+	source/index.txt			\
+	source/process.txt			\
+	source/pseudo_column.txt		\
+	source/rdoc.py				\
+	source/reference.txt			\
+	source/tutorial.txt			\
+	source/tutorial/tutorial01.txt		\
+	source/tutorial/tutorial02.txt		\
+	source/tutorial/tutorial03.txt		\
+	source/tutorial/tutorial04.txt		\
+	source/tutorial/tutorial05.txt		\
+	source/tutorial/tutorial06.txt		\
+	source/tutorial/tutorial07.txt		\
+	source/tutorial/tutorial08.txt		\
+	source/tutorial/tutorial09.txt		\
+	source/tutorial/tutorial10.txt		\
+	source/type.txt				\
+	source/update_execution_example.py

  Added: doc/ja/build/Makefile.am (+82 -0) 100644
===================================================================
--- /dev/null
+++ doc/ja/build/Makefile.am    2010-08-20 07:52:17 +0000 (0ee4d52)
@@ -0,0 +1,82 @@
+docdir = $(pkgdatadir)/doc
+doc_jadir = $(docdir)/ja
+
+html/_static/basic.css:
+	$(MAKE) -C $(srcdir)/.. html
+
+# find html -name '_sources' -prune -type f -o -type f -a -not -name '.buildinfo' | sort | sed -e 's,^,\t,g'
+nobase_dist_doc_ja_DATA =			\
+	html/_static/basic.css			\
+	html/_static/default.css		\
+	html/_static/doctools.js		\
+	html/_static/file.png			\
+	html/_static/jquery.js			\
+	html/_static/minus.png			\
+	html/_static/plus.png			\
+	html/_static/pygments.css		\
+	html/_static/searchtools.js		\
+	html/_static/sidebar.js			\
+	html/_static/underscore.js		\
+	html/characteristic.html		\
+	html/commands.html			\
+	html/commands/cache_limit.html		\
+	html/commands/check.html		\
+	html/commands/clearlock.html		\
+	html/commands/column_create.html	\
+	html/commands/column_list.html		\
+	html/commands/column_remove.html	\
+	html/commands/define_selector.html	\
+	html/commands/defrag.html		\
+	html/commands/delete.html		\
+	html/commands/dump.html			\
+	html/commands/load.html			\
+	html/commands/log_level.html		\
+	html/commands/log_put.html		\
+	html/commands/log_reopen.html		\
+	html/commands/quit.html			\
+	html/commands/select.html		\
+	html/commands/shutdown.html		\
+	html/commands/status.html		\
+	html/commands/table_create.html		\
+	html/commands/table_list.html		\
+	html/commands/table_remove.html		\
+	html/commands/view_add.html		\
+	html/commands_not_implemented/add.html	\
+	html/commands_not_implemented/get.html	\
+	html/commands_not_implemented/set.html	\
+	html/developer.html			\
+	html/developer/com.html			\
+	html/developer/document.html		\
+	html/developer/query.html		\
+	html/developer/test.html		\
+	html/execfile.html			\
+	html/expr.html				\
+	html/functions.html			\
+	html/functions/geo_distance.html	\
+	html/functions/geo_in_circle.html	\
+	html/functions/geo_in_rectangle.html	\
+	html/functions/now.html			\
+	html/functions/rand.html		\
+	html/genindex.html			\
+	html/grnslap.html			\
+	html/grntest.html			\
+	html/http.html				\
+	html/index.html				\
+	html/objects.inv			\
+	html/process.html			\
+	html/pseudo_column.html			\
+	html/reference.html			\
+	html/search.html			\
+	html/searchindex.js			\
+	html/tutorial.html			\
+	html/tutorial/tutorial01.html		\
+	html/tutorial/tutorial02.html		\
+	html/tutorial/tutorial03.html		\
+	html/tutorial/tutorial04.html		\
+	html/tutorial/tutorial05.html		\
+	html/tutorial/tutorial06.html		\
+	html/tutorial/tutorial07.html		\
+	html/tutorial/tutorial08.html		\
+	html/tutorial/tutorial09.html		\
+	html/tutorial/tutorial10.html		\
+	html/type.html




Groonga-commit メーリングリストの案内
Back to archive index