[Python-checkins] r56856 - in doctools/trunk: Doc-26 Doc-26/Makefile Doc-26/tools Doc-26/tools/sphinx-build.py Doc-26/tools/sphinx-web.py Doc-26/tutorial/modules.rst Doc-3k Doc-3k/Makefile Doc-3k/tools Doc-3k/tools/sphinx-build.py Doc-3k/tools/sphinx-web.py Doc-3k/tutorial/modules.rst
georg.brandl
python-checkins at python.org
Thu Aug 9 17:46:07 CEST 2007
Author: georg.brandl
Date: Thu Aug 9 17:46:06 2007
New Revision: 56856
Added:
doctools/trunk/Doc-26/Makefile
doctools/trunk/Doc-26/tools/sphinx-build.py
doctools/trunk/Doc-26/tools/sphinx-web.py
doctools/trunk/Doc-3k/Makefile
doctools/trunk/Doc-3k/tools/sphinx-build.py
doctools/trunk/Doc-3k/tools/sphinx-web.py
Modified:
doctools/trunk/Doc-26/ (props changed)
doctools/trunk/Doc-26/tools/ (props changed)
doctools/trunk/Doc-26/tutorial/modules.rst
doctools/trunk/Doc-3k/ (props changed)
doctools/trunk/Doc-3k/tools/ (props changed)
doctools/trunk/Doc-3k/tutorial/modules.rst
Log:
Add a Makefile to the Doc trees.
Added: doctools/trunk/Doc-26/Makefile
==============================================================================
--- (empty file)
+++ doctools/trunk/Doc-26/Makefile Thu Aug 9 17:46:06 2007
@@ -0,0 +1,55 @@
+#
+# Makefile for Python documentation
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+#
+
+PYTHON = python
+SVNROOT = http://svn.python.org/projects
+
+.PHONY: default checkout html web htmlhelp clean
+
+default:
+ @echo "Please use \`make <target>' where <target> is one of"
+ @echo " html to make standalone HTML files"
+ @echo " web to make file usable by Sphinx.web"
+ @echo " htmlhelp to make HTML files and a HTML help project"
+
+checkout:
+ @if [ ! -d tools/sphinx ]; then \
+ echo "Checking out Sphinx..."; \
+ svn checkout $(SVNROOT)/doctools/trunk/sphinx tools/sphinx; \
+ echo "Checking out Pygments..."; \
+ svn checkout $(SVNROOT)/external/Pygments-0.8.1/pygments tools/pygments; \
+ else \
+ echo "Sphinx already checked out, run \`make update' to update" \
+ "the toolchain."; \
+ fi
+
+update:
+ svn update tools/sphinx
+ svn update tools/pygments
+
+html: checkout
+ mkdir -p build/html build/doctrees
+ $(PYTHON) tools/sphinx-build.py -bhtml -dbuild/doctrees . build/html
+ @echo
+ @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
+ @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
+ @echo "Build finished; now you can run HTML Help Workshop with the" \
+ "build/hhp/pydoc.hhp project file."
+
+clean:
+ -rm -rf build/*
+ -rm -rf tools/sphinx
Added: doctools/trunk/Doc-26/tools/sphinx-build.py
==============================================================================
--- (empty file)
+++ doctools/trunk/Doc-26/tools/sphinx-build.py Thu Aug 9 17:46:06 2007
@@ -0,0 +1,14 @@
+# -*- coding: utf-8 -*-
+"""
+ Sphinx - Python documentation toolchain
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+ :copyright: 2007 by Georg Brandl.
+ :license: Python license.
+"""
+
+import sys
+
+if __name__ == '__main__':
+ from sphinx import main
+ sys.exit(main(sys.argv))
Added: doctools/trunk/Doc-26/tools/sphinx-web.py
==============================================================================
--- (empty file)
+++ doctools/trunk/Doc-26/tools/sphinx-web.py Thu Aug 9 17:46:06 2007
@@ -0,0 +1,14 @@
+# -*- coding: utf-8 -*-
+"""
+ Sphinx - Python documentation webserver
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+ :copyright: 2007 by Georg Brandl.
+ :license: Python license.
+"""
+
+import sys
+
+if __name__ == '__main__':
+ from sphinx.web import main
+ sys.exit(main(sys.argv))
Modified: doctools/trunk/Doc-26/tutorial/modules.rst
==============================================================================
--- doctools/trunk/Doc-26/tutorial/modules.rst (original)
+++ doctools/trunk/Doc-26/tutorial/modules.rst Thu Aug 9 17:46:06 2007
@@ -510,10 +510,10 @@
statement looks for a top-level module with the given name.
When packages are structured into subpackages (as with the :mod:`sound` package
-in the example), there's no shortcut to refer to submodules of sibling packages
-- the full name of the subpackage must be used. For example, if the module
-:mod:`sound.filters.vocoder` needs to use the :mod:`echo` module in the
-:mod:`sound.effects` package, it can use ``from sound.effects import echo``.
+in the example), you can use absolute imports to refer to submodules of siblings
+packages. For example, if the module :mod:`sound.filters.vocoder` needs to use
+the :mod:`echo` module in the :mod:`sound.effects` package, it can use ``from
+sound.effects import echo``.
Starting with Python 2.5, in addition to the implicit relative imports described
above, you can write explicit relative imports with the ``from module import
Added: doctools/trunk/Doc-3k/Makefile
==============================================================================
--- (empty file)
+++ doctools/trunk/Doc-3k/Makefile Thu Aug 9 17:46:06 2007
@@ -0,0 +1,55 @@
+#
+# Makefile for Python documentation
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+#
+
+PYTHON = python
+SVNROOT = http://svn.python.org/projects
+
+.PHONY: default checkout html web htmlhelp clean
+
+default:
+ @echo "Please use \`make <target>' where <target> is one of"
+ @echo " html to make standalone HTML files"
+ @echo " web to make file usable by Sphinx.web"
+ @echo " htmlhelp to make HTML files and a HTML help project"
+
+checkout:
+ @if [ ! -d tools/sphinx ]; then \
+ echo "Checking out Sphinx..."; \
+ svn checkout $(SVNROOT)/doctools/trunk/sphinx tools/sphinx; \
+ echo "Checking out Pygments..."; \
+ svn checkout $(SVNROOT)/external/Pygments-0.8.1/pygments tools/pygments; \
+ else \
+ echo "Sphinx already checked out, run \`make update' to update" \
+ "the toolchain."; \
+ fi
+
+update:
+ svn update tools/sphinx
+ svn update tools/pygments
+
+html: checkout
+ mkdir -p build/html build/doctrees
+ $(PYTHON) tools/sphinx-build.py -bhtml -dbuild/doctrees . build/html
+ @echo
+ @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
+ @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
+ @echo "Build finished; now you can run HTML Help Workshop with the" \
+ "build/hhp/pydoc.hhp project file."
+
+clean:
+ -rm -rf build/*
+ -rm -rf tools/sphinx
Added: doctools/trunk/Doc-3k/tools/sphinx-build.py
==============================================================================
--- (empty file)
+++ doctools/trunk/Doc-3k/tools/sphinx-build.py Thu Aug 9 17:46:06 2007
@@ -0,0 +1,14 @@
+# -*- coding: utf-8 -*-
+"""
+ Sphinx - Python documentation toolchain
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+ :copyright: 2007 by Georg Brandl.
+ :license: Python license.
+"""
+
+import sys
+
+if __name__ == '__main__':
+ from sphinx import main
+ sys.exit(main(sys.argv))
Added: doctools/trunk/Doc-3k/tools/sphinx-web.py
==============================================================================
--- (empty file)
+++ doctools/trunk/Doc-3k/tools/sphinx-web.py Thu Aug 9 17:46:06 2007
@@ -0,0 +1,14 @@
+# -*- coding: utf-8 -*-
+"""
+ Sphinx - Python documentation webserver
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+ :copyright: 2007 by Georg Brandl.
+ :license: Python license.
+"""
+
+import sys
+
+if __name__ == '__main__':
+ from sphinx.web import main
+ sys.exit(main(sys.argv))
Modified: doctools/trunk/Doc-3k/tutorial/modules.rst
==============================================================================
--- doctools/trunk/Doc-3k/tutorial/modules.rst (original)
+++ doctools/trunk/Doc-3k/tutorial/modules.rst Thu Aug 9 17:46:06 2007
@@ -510,10 +510,10 @@
statement looks for a top-level module with the given name.
When packages are structured into subpackages (as with the :mod:`sound` package
-in the example), there's no shortcut to refer to submodules of sibling packages
-- the full name of the subpackage must be used. For example, if the module
-:mod:`sound.filters.vocoder` needs to use the :mod:`echo` module in the
-:mod:`sound.effects` package, it can use ``from sound.effects import echo``.
+in the example), you can use absolute imports to refer to submodules of siblings
+packages. For example, if the module :mod:`sound.filters.vocoder` needs to use
+the :mod:`echo` module in the :mod:`sound.effects` package, it can use ``from
+sound.effects import echo``.
Starting with Python 2.5, in addition to the implicit relative imports described
above, you can write explicit relative imports with the ``from module import
More information about the Python-checkins
mailing list