mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
56 lines
1.6 KiB
Makefile
56 lines
1.6 KiB
Makefile
#
|
|
# 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
|