[Python-checkins] r56888 - in doctools/trunk: Doc-26/Makefile Doc-26/README.txt Doc-3k/Makefile Doc-3k/README.txt sphinx
georg.brandl
python-checkins at python.org
Fri Aug 10 07:59:40 CEST 2007
Author: georg.brandl
Date: Fri Aug 10 07:59:40 2007
New Revision: 56888
Modified:
doctools/trunk/Doc-26/Makefile
doctools/trunk/Doc-26/README.txt
doctools/trunk/Doc-3k/Makefile
doctools/trunk/Doc-3k/README.txt
doctools/trunk/sphinx/ (props changed)
Log:
Move jinja external to svn.python.org, extend Makefile.
Modified: doctools/trunk/Doc-26/Makefile
==============================================================================
--- doctools/trunk/Doc-26/Makefile (original)
+++ doctools/trunk/Doc-26/Makefile Fri Aug 10 07:59:40 2007
@@ -3,10 +3,14 @@
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#
-PYTHON = python
-SVNROOT = http://svn.python.org/projects
+# You can set these variables from the command line.
+PYTHON ?= python
+SVNROOT ?= http://svn.python.org/projects
+SPHINXOPTS ?=
-.PHONY: help checkout html web htmlhelp clean
+ALLSPHINXOPTS = -b$(BUILDER) -dbuild/doctrees $(SPHINXOPTS) . build/$(BUILDER)
+
+.PHONY: help checkout update build html web htmlhelp clean
help:
@echo "Please use \`make <target>' where <target> is one of"
@@ -33,24 +37,23 @@
svn update tools/docutils
svn update tools/pygments
-html: checkout
- mkdir -p build/html build/doctrees
- $(PYTHON) tools/sphinx-build.py -bhtml -dbuild/doctrees . build/html
+build: checkout
+ mkdir -p build/$(BUILDER) build/doctrees
+ $(PYTHON) tools/sphinx-build.py $(ALLSPHINXOPTS)
@echo
+
+html: BUILDER = html
+html: build
@echo "Build finished. The HTML pages are in build/html."
-web: checkout
- mkdir -p build/web build/doctrees
- $(PYTHON) tools/sphinx-build.py -bweb -dbuild/doctrees . build/web
- @echo
+web: BUILDER = web
+web: build
@echo "Build finished; now you can run"
@echo " PYTHONPATH=tools $(PYTHON) -m sphinx.web build/web"
@echo "to start the server."
-htmlhelp: checkout
- mkdir -p build/hhp build/doctrees
- $(PYTHON) tools/sphinx-build.py -bhtmlhelp -dbuild/doctrees . build/hhp
- @echo
+htmlhelp: BUILDER = htmlhelp
+htmlhelp: build
@echo "Build finished; now you can run HTML Help Workshop with the" \
"build/hhp/pydoc.hhp project file."
Modified: doctools/trunk/Doc-26/README.txt
==============================================================================
--- doctools/trunk/Doc-26/README.txt (original)
+++ doctools/trunk/Doc-26/README.txt Fri Aug 10 07:59:40 2007
@@ -16,8 +16,9 @@
You need to install Python 2.5 or higher; the toolset used to build the docs are
written in Python. The toolset used to build the documentation is called
*Sphinx*, it is not included in this tree, but maintained separately in the
-Python Subversion repository. Also needed are Jinja, a templating engine, and
-optionally Pygments, a code highlighter.
+Python Subversion repository. Also needed are Jinja, a templating engine
+(included in Sphinx as a Subversion external), and optionally Pygments, a code
+highlighter.
Using make
Modified: doctools/trunk/Doc-3k/Makefile
==============================================================================
--- doctools/trunk/Doc-3k/Makefile (original)
+++ doctools/trunk/Doc-3k/Makefile Fri Aug 10 07:59:40 2007
@@ -3,10 +3,14 @@
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#
-PYTHON = python
-SVNROOT = http://svn.python.org/projects
+# You can set these variables from the command line.
+PYTHON ?= python
+SVNROOT ?= http://svn.python.org/projects
+SPHINXOPTS ?=
-.PHONY: help checkout html web htmlhelp clean
+ALLSPHINXOPTS = -b$(BUILDER) -dbuild/doctrees $(SPHINXOPTS) . build/$(BUILDER)
+
+.PHONY: help checkout update build html web htmlhelp clean
help:
@echo "Please use \`make <target>' where <target> is one of"
@@ -33,24 +37,23 @@
svn update tools/docutils
svn update tools/pygments
-html: checkout
- mkdir -p build/html build/doctrees
- $(PYTHON) tools/sphinx-build.py -bhtml -dbuild/doctrees . build/html
+build: checkout
+ mkdir -p build/$(BUILDER) build/doctrees
+ $(PYTHON) tools/sphinx-build.py $(ALLSPHINXOPTS)
@echo
+
+html: BUILDER = html
+html: build
@echo "Build finished. The HTML pages are in build/html."
-web: checkout
- mkdir -p build/web build/doctrees
- $(PYTHON) tools/sphinx-build.py -bweb -dbuild/doctrees . build/web
- @echo
+web: BUILDER = web
+web: build
@echo "Build finished; now you can run"
@echo " PYTHONPATH=tools $(PYTHON) -m sphinx.web build/web"
@echo "to start the server."
-htmlhelp: checkout
- mkdir -p build/hhp build/doctrees
- $(PYTHON) tools/sphinx-build.py -bhtmlhelp -dbuild/doctrees . build/hhp
- @echo
+htmlhelp: BUILDER = htmlhelp
+htmlhelp: build
@echo "Build finished; now you can run HTML Help Workshop with the" \
"build/hhp/pydoc.hhp project file."
Modified: doctools/trunk/Doc-3k/README.txt
==============================================================================
--- doctools/trunk/Doc-3k/README.txt (original)
+++ doctools/trunk/Doc-3k/README.txt Fri Aug 10 07:59:40 2007
@@ -16,8 +16,9 @@
You need to install Python 2.5 or higher; the toolset used to build the docs are
written in Python. The toolset used to build the documentation is called
*Sphinx*, it is not included in this tree, but maintained separately in the
-Python Subversion repository. Also needed are Jinja, a templating engine, and
-optionally Pygments, a code highlighter.
+Python Subversion repository. Also needed are Jinja, a templating engine
+(included in Sphinx as a Subversion external), and optionally Pygments, a code
+highlighter.
Using make
More information about the Python-checkins
mailing list