111 lines
3.4 KiB
Makefile
111 lines
3.4 KiB
Makefile
#
|
|
# Makefile for Python documentation
|
|
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
#
|
|
|
|
# You can set these variables from the command line.
|
|
PYTHON = python
|
|
SVNROOT = http://svn.python.org/projects
|
|
SPHINXOPTS =
|
|
PAPER =
|
|
SOURCES =
|
|
|
|
ALLSPHINXOPTS = -b $(BUILDER) -d build/doctrees -D latex_paper_size=$(PAPER) \
|
|
$(SPHINXOPTS) . build/$(BUILDER) $(SOURCES)
|
|
|
|
.PHONY: help checkout update build html web htmlhelp clean coverage
|
|
|
|
help:
|
|
@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"
|
|
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
|
|
@echo " text to make plain text files"
|
|
@echo " changes to make an overview over all changed/added/deprecated items"
|
|
@echo " linkcheck to check all external links for integrity"
|
|
@echo " coverage to check documentation coverage for library and C API"
|
|
|
|
checkout:
|
|
@if [ ! -d tools/sphinx ]; then \
|
|
echo "Checking out Sphinx..."; \
|
|
svn checkout $(SVNROOT)/doctools/trunk/sphinx tools/sphinx; \
|
|
fi
|
|
@if [ ! -d tools/docutils ]; then \
|
|
echo "Checking out Docutils..."; \
|
|
svn checkout $(SVNROOT)/external/docutils-0.5/docutils tools/docutils; \
|
|
fi
|
|
@if [ ! -d tools/jinja ]; then \
|
|
echo "Checking out Jinja..."; \
|
|
svn checkout $(SVNROOT)/external/Jinja-1.2/jinja tools/jinja; \
|
|
fi
|
|
@if [ ! -d tools/pygments ]; then \
|
|
echo "Checking out Pygments..."; \
|
|
svn checkout $(SVNROOT)/external/Pygments-0.10/pygments tools/pygments; \
|
|
fi
|
|
|
|
update: checkout
|
|
svn update tools/sphinx
|
|
svn update tools/docutils
|
|
svn update tools/jinja
|
|
svn update tools/pygments
|
|
|
|
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: 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: BUILDER = htmlhelp
|
|
htmlhelp: build
|
|
@echo "Build finished; now you can run HTML Help Workshop with the" \
|
|
"build/htmlhelp/pydoc.hhp project file."
|
|
|
|
latex: BUILDER = latex
|
|
latex: build
|
|
@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."
|
|
|
|
text: BUILDER = text
|
|
text: build
|
|
@echo "Build finished; the text files are in build/text."
|
|
|
|
changes: BUILDER = changes
|
|
changes: build
|
|
@echo "The overview file is in build/changes."
|
|
|
|
linkcheck: BUILDER = linkcheck
|
|
linkcheck: build
|
|
@echo "Link check complete; look for any errors in the above output " \
|
|
"or in build/$(BUILDER)/output.txt"
|
|
|
|
coverage: BUILDER = coverage
|
|
coverage: build
|
|
@echo "Coverage finished; see c.txt and python.txt in build/coverage"
|
|
|
|
doctest: BUILDER = doctest
|
|
doctest: build
|
|
@echo "Testing of doctests in the sources finished, look at the " \
|
|
"results in build/doctest/output.txt"
|
|
|
|
pydoc-topics: BUILDER = pydoc-topics
|
|
pydoc-topics: build
|
|
@echo "Building finished; now copy build/pydoc-topics/pydoc_topics.py " \
|
|
"into the Lib/ directory"
|
|
|
|
htmlview: html
|
|
$(PYTHON) -c "import webbrowser; webbrowser.open('build/html/index.html')"
|
|
clean:
|
|
-rm -rf build/*
|
|
-rm -rf tools/sphinx
|