[Scipy-svn] r5233 - in trunk/doc: . source

scipy-svn@scip... scipy-svn@scip...
Sun Dec 7 16:05:38 CST 2008


Author: ptvirtan
Date: 2008-12-07 16:05:26 -0600 (Sun, 07 Dec 2008)
New Revision: 5233

Modified:
   trunk/doc/Makefile
   trunk/doc/source/conf.py
Log:
docs: more support for htmlhelp

Modified: trunk/doc/Makefile
===================================================================
--- trunk/doc/Makefile	2008-12-07 17:44:59 UTC (rev 5232)
+++ trunk/doc/Makefile	2008-12-07 22:05:26 UTC (rev 5233)
@@ -36,13 +36,14 @@
 dist: html
 	test -d build/latex || make latex
 	-make -C build/latex all-pdf
+	-test -d build/htmlhelp || make htmlhelp-build
 	-rm -rf build/dist
-	mkdir -p build/dist
-	cp -r build/html build/dist/reference
+	cp -r build/html build/dist
 	touch build/dist/index.html
-	perl -pi -e 's#^\s*(<li><a href=".*?">SciPy.*?Reference Guide.*?&raquo;</li>)\s*$$#<li><a href="/">Numpy and Scipy Documentation</a> &raquo;</li> $$1#;' build/dist/*.html build/dist/*/*.html build/dist/*/*/*.html
+	perl -pi -e 's#^\s*(<li><a href=".*?">SciPy.*?Manual.*?&raquo;</li>)\s*$$#<li><a href="/">Numpy and Scipy Documentation</a> &raquo;</li> $$1#;' build/dist/*.html build/dist/*/*.html build/dist/*/*/*.html
 	(cd build/html && zip -9qr ../dist/scipy-html.zip .)
-	cp build/latex/*.pdf build/dist
+	cp build/latex/scipy.pdf build/dist
+	-cp build/htmlhelp/scipy.chm build/dist
 	cd build/dist && tar czf ../dist.tar.gz *
 	chmod ug=rwX,o=rX -R build/dist
 	find build/dist -type d -print0 | xargs -0r chmod g+s
@@ -78,10 +79,15 @@
 	@echo "Build finished; now you can run HTML Help Workshop with the" \
 	      ".hhp project file in build/htmlhelp."
 
+htmlhelp-build: htmlhelp build/htmlhelp/scipy.chm
+%.chm: %.hhp
+	-hhc.exe $^
+
 latex: generate
 	mkdir -p build/latex build/doctrees
 	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) build/latex
 	python postprocess.py tex build/latex/*.tex
+	perl -pi -e 's/\t(latex.*|pdflatex) (.*)/\t-$$1 -interaction batchmode $$2/' build/latex/Makefile
 	@echo
 	@echo "Build finished; the LaTeX files are in build/latex."
 	@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
@@ -106,4 +112,4 @@
 	      "or in build/linkcheck/output.txt."
 
 .PHONY: help clean upload dist generate html pickle web htmlhelp latex \
-	coverage changes linkcheck
+	coverage changes linkcheck htmlhelp-build

Modified: trunk/doc/source/conf.py
===================================================================
--- trunk/doc/source/conf.py	2008-12-07 17:44:59 UTC (rev 5232)
+++ trunk/doc/source/conf.py	2008-12-07 22:05:26 UTC (rev 5233)
@@ -69,7 +69,7 @@
 
 # If true, sectionauthor and moduleauthor directives will be shown in the
 # output. They are ignored by default.
-show_authors = True
+show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
@@ -86,7 +86,7 @@
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
-html_title = "%s v%s Reference Guide (DRAFT)" % (project, version)
+html_title = "%s v%s Manual (DRAFT)" % (project, version)
 
 # The name of an image file (within the static path) to place at the top of
 # the sidebar.
@@ -132,7 +132,7 @@
 html_file_suffix = '.html'
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'NumPydoc'
+htmlhelp_basename = 'scipy'
 
 # Pngmath should try to align formulas properly
 pngmath_use_preview = True
@@ -152,8 +152,7 @@
 # (source start file, target name, title, author, document class [howto/manual]).
 _stdauthor = 'Written by the SciPy community'
 latex_documents = [
-  ('index', 'scipy-ref.tex', 'SciPy Reference Guide',
-   _stdauthor, 'manual'),
+  ('index', 'scipy.tex', 'SciPy Guide', _stdauthor, 'manual'),
 #  ('user/index', 'scipy-user.tex', 'SciPy User Guide',
 #   _stdauthor, 'manual'),
 ]



More information about the Scipy-svn mailing list