[QGIS Commit] r14055 - in docs/trunk/english_us/developer_cookbook: . source

[svn_qgis at osgeo.org]

Author: dassau
Date: 2010-08-11 10:06:55 +0000 (Wed, 11 Aug 2010)
New Revision: 14055

Modified:
   docs/trunk/english_us/developer_cookbook/Makefile
   docs/trunk/english_us/developer_cookbook/source/index.rst
Log:
migration to qgis.org

Modified: docs/trunk/english_us/developer_cookbook/Makefile
===================================================================
--- docs/trunk/english_us/developer_cookbook/Makefile	2010-08-11 08:12:06 UTC (rev 14054)
+++ docs/trunk/english_us/developer_cookbook/Makefile	2010-08-11 10:06:55 UTC (rev 14055)
@@ -11,60 +11,45 @@
 PAPEROPT_letter = -D latex_paper_size=letter
 ALLSPHINXOPTS   = -d build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
 
-.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
+.PHONY: help clean html web pickle htmlhelp latex changes linkcheck
 
 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 "  pickle    to make pickle files (usable by e.g. sphinx-web)"
 	@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 "  changes   to make an overview of all changed/added/deprecated items"
+	@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)"
 
 clean:
 	-rm -rf build/*
 
 html:
+	mkdir -p build/html build/doctrees
 	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) build/html
 	@echo
 	@echo "Build finished. The HTML pages are in build/html."
 
-dirhtml:
-	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) build/dirhtml
-	@echo
-	@echo "Build finished. The HTML pages are in build/dirhtml."
-
 pickle:
+	mkdir -p build/pickle build/doctrees
 	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) build/pickle
 	@echo
-	@echo "Build finished; now you can process the pickle files."
+	@echo "Build finished; now you can process the pickle files or run"
+	@echo "  sphinx-web build/pickle"
+	@echo "to start the sphinx-web server."
 
-json:
-	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) build/json
-	@echo
-	@echo "Build finished; now you can process the JSON files."
+web: pickle
 
 htmlhelp:
+	mkdir -p build/htmlhelp build/doctrees
 	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) build/htmlhelp
 	@echo
 	@echo "Build finished; now you can run HTML Help Workshop with the" \
 	      ".hhp project file in build/htmlhelp."
 
-qthelp:
-	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) build/qthelp
-	@echo
-	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
-	      ".qhcp project file in build/qthelp, like this:"
-	@echo "# qcollectiongenerator build/qthelp/PyQGIS.qhcp"
-	@echo "To view the help file:"
-	@echo "# assistant -collectionFile build/qthelp/PyQGIS.qhc"
-
 latex:
+	mkdir -p build/latex build/doctrees
 	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) build/latex
 	@echo
 	@echo "Build finished; the LaTeX files are in build/latex."
@@ -72,17 +57,14 @@
 	      "run these through (pdf)latex."
 
 changes:
+	mkdir -p build/changes build/doctrees
 	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) build/changes
 	@echo
 	@echo "The overview file is in build/changes."
 
 linkcheck:
+	mkdir -p build/linkcheck build/doctrees
 	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) build/linkcheck
 	@echo
 	@echo "Link check complete; look for any errors in the above output " \
 	      "or in build/linkcheck/output.txt."
-
-doctest:
-	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) build/doctest
-	@echo "Testing of doctests in the sources finished, look at the " \
-	      "results in build/doctest/output.txt."

Modified: docs/trunk/english_us/developer_cookbook/source/index.rst
===================================================================
--- docs/trunk/english_us/developer_cookbook/source/index.rst	2010-08-11 08:12:06 UTC (rev 14054)
+++ docs/trunk/english_us/developer_cookbook/source/index.rst	2010-08-11 10:06:55 UTC (rev 14055)
@@ -1,10 +1,10 @@
-.. PyQGIS documentation master file, created by
+.. PyQGIS documentation master file, created by 
    sphinx-quickstart on Fri Apr 16 10:42:28 2010.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
 PyQGIS Developer Cookbook
-=========================
+===========================================
 
 Contents:
 
@@ -24,7 +24,6 @@
    plugins
    todolist
 
-
 Indices and tables
 ==================