Anonymous avatar Anonymous committed 63866d2

Add a Makefile to the Doc trees.

Comments (0)

Files changed (8)

+#
+# 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

Doc-26/tools/sphinx-build.py

+# -*- 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))

Doc-26/tools/sphinx-web.py

+# -*- 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))

Doc-26/tutorial/modules.rst

 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
+#
+# 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

Doc-3k/tools/sphinx-build.py

+# -*- 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))

Doc-3k/tools/sphinx-web.py

+# -*- 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))

Doc-3k/tutorial/modules.rst

 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
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.