[Scipy-svn] r5127 - scipy-docs/trunk trunk/doc

scipy-svn@scip... scipy-svn@scip...
Sun Nov 16 05:35:17 CST 2008


Author: ptvirtan
Date: 2008-11-16 05:34:49 -0600 (Sun, 16 Nov 2008)
New Revision: 5127

Added:
   trunk/doc/Makefile
   trunk/doc/README.txt
   trunk/doc/frontpage/
   trunk/doc/postprocess.py
   trunk/doc/source/
Removed:
   scipy-docs/trunk/Makefile
   scipy-docs/trunk/README.txt
   scipy-docs/trunk/frontpage/
   scipy-docs/trunk/postprocess.py
   scipy-docs/trunk/source/
Log:
Moving scipy-docs under the main Scipy tree

Deleted: scipy-docs/trunk/Makefile
===================================================================
--- scipy-docs/trunk/Makefile	2008-11-16 09:23:48 UTC (rev 5126)
+++ scipy-docs/trunk/Makefile	2008-11-16 11:34:49 UTC (rev 5127)
@@ -1,112 +0,0 @@
-# Makefile for Sphinx documentation
-#
-
-# You can set these variables from the command line.
-SPHINXOPTS    =
-SPHINXBUILD   = LANG=C sphinx-build
-PAPER         =
-
-# Internal variables.
-PAPEROPT_a4     = -D latex_paper_size=a4
-PAPEROPT_letter = -D latex_paper_size=letter
-ALLSPHINXOPTS   = -d build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
-
-.PHONY: help clean html web pickle htmlhelp latex changes linkcheck
-
-help:
-	@echo "Please use \`make <target>' where <target> is one of"
-	@echo "  dist      to make a distribution-ready tree"
-	@echo "  html      to make standalone HTML 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 "  latex     to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
-	@echo "  changes   to make an overview over all changed/added/deprecated items"
-	@echo "  linkcheck to check all external links for integrity"
-	@echo "  upload USER=...  to upload results to docs.scipy.org"
-
-clean:
-	-rm -rf build/* source/generated
-
-upload:
-	@test -e build/dist || { echo "make dist is required first"; exit 1; }
-	@test output-is-fine -nt build/dist || { \
-	    echo "Review the output in build/dist, and do 'touch output-is-fine' before uploading."; exit 1; }
-	rsync -r -z --delete-after -p build/dist/ $(USER)@docs.scipy.org:/home/docserver/www-root/doc/scipy/
-
-dist: html
-	test -d build/latex || make latex
-	-make -C build/latex all-pdf
-	-rm -rf build/dist
-	mkdir -p build/dist
-	cp -r build/html build/dist/reference
-	touch build/dist/index.html
-	perl -pi -e 's#^\s*(<li><a href=".*?">SciPy.*?Reference Guide.*?&raquo;</li>)$$#<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
-	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
-
-generate: build/generate-stamp
-build/generate-stamp: $(wildcard source/*.rst) ext
-	mkdir -p build
-	./ext/autosummary_generate.py source/*.rst \
-		-p dump.xml -o source/generated 
-	touch build/generate-stamp
-
-ext:
-	svn co http://sphinx.googlecode.com/svn/contrib/trunk/numpyext ext
-
-html: generate
-	mkdir -p build/html build/doctrees
-	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) build/html
-	python postprocess.py html build/html/*.html
-	@echo
-	@echo "Build finished. The HTML pages are in build/html."
-
-pickle: generate
-	mkdir -p build/pickle build/doctrees
-	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) build/pickle
-	@echo
-	@echo "Build finished; now you can process the pickle files or run"
-	@echo "  sphinx-web build/pickle"
-	@echo "to start the sphinx-web server."
-
-web: pickle
-
-htmlhelp: generate
-	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."
-
-latex: generate
-	mkdir -p build/latex build/doctrees
-	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) build/latex
-	python postprocess.py tex build/latex/*.tex
-	@echo
-	@echo "Build finished; the LaTeX files are in build/latex."
-	@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
-	      "run these through (pdf)latex."
-
-coverage: build
-	mkdir -p build/coverage build/doctrees
-	$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) build/coverage
-	@echo "Coverage finished; see c.txt and python.txt in build/coverage"
-
-changes: generate
-	mkdir -p build/changes build/doctrees
-	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) build/changes
-	@echo
-	@echo "The overview file is in build/changes."
-
-linkcheck: generate
-	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."
-
-.PHONY: help clean upload dist generate html pickle web htmlhelp latex \
-	coverage changes linkcheck

Deleted: scipy-docs/trunk/README.txt
===================================================================
--- scipy-docs/trunk/README.txt	2008-11-16 09:23:48 UTC (rev 5126)
+++ scipy-docs/trunk/README.txt	2008-11-16 11:34:49 UTC (rev 5127)
@@ -1,12 +0,0 @@
-SciPy Reference Guide
-=====================
-
-Instructions
-------------
-1. Optionally download an XML dump of the newest docstrings from the doc wiki
-   at ``/pydocweb/dump`` and save it as ``dump.xml``.
-2. Run ``make html`` or ``make dist``
-
-You can also run ``summarize.py`` to see which parts of the Numpy
-namespace are documented.
-

Deleted: scipy-docs/trunk/postprocess.py
===================================================================
--- scipy-docs/trunk/postprocess.py	2008-11-16 09:23:48 UTC (rev 5126)
+++ scipy-docs/trunk/postprocess.py	2008-11-16 11:34:49 UTC (rev 5127)
@@ -1,54 +0,0 @@
-#!/usr/bin/env python
-"""
-%prog MODE FILES...
-
-Post-processes HTML and Latex files output by Sphinx.
-MODE is either 'html' or 'tex'.
-
-"""
-import re, optparse
-
-def main():
-    p = optparse.OptionParser(__doc__)
-    options, args = p.parse_args()
-
-    if len(args) < 1:
-        p.error('no mode given')
-
-    mode = args.pop(0)
-
-    if mode not in ('html', 'tex'):
-        p.error('unknown mode %s' % mode)
-
-    for fn in args:
-        f = open(fn, 'r')
-        try:
-            if mode == 'html':
-                lines = process_html(fn, f.readlines())
-            elif mode == 'tex':
-                lines = process_tex(f.readlines())
-        finally:
-            f.close()
-
-        f = open(fn, 'w')
-        f.write("".join(lines))
-        f.close()
-
-def process_html(fn, lines):
-    return lines
-
-def process_tex(lines):
-    """
-    Remove unnecessary section titles from the LaTeX file.
-    
-    """
-    new_lines = []
-    for line in lines:
-        if re.match(r'^\\(section|subsection|subsubsection|paragraph|subparagraph){(numpy|scipy)\.', line):
-            pass # skip!
-        else:
-            new_lines.append(line)
-    return new_lines
-
-if __name__ == "__main__":
-    main()

Copied: trunk/doc/Makefile (from rev 5126, scipy-docs/trunk/Makefile)

Copied: trunk/doc/README.txt (from rev 5126, scipy-docs/trunk/README.txt)

Copied: trunk/doc/frontpage (from rev 5126, scipy-docs/trunk/frontpage)

Copied: trunk/doc/postprocess.py (from rev 5126, scipy-docs/trunk/postprocess.py)

Copied: trunk/doc/source (from rev 5126, scipy-docs/trunk/source)



More information about the Scipy-svn mailing list