Makefile
144 lines
| 4.5 KiB
| text/x-makefile
|
MakefileLexer
/ docs / Makefile
Brian E Granger
|
r1256 | # Makefile for Sphinx documentation | ||
# | ||||
# You can set these variables from the command line. | ||||
SPHINXOPTS = | ||||
SPHINXBUILD = sphinx-build | ||||
PAPER = | ||||
Fernando Perez
|
r1850 | SRCDIR = source | ||
Rustam Safin
|
r8944 | BUILDDIR = build | ||
Brian E Granger
|
r1256 | |||
# Internal variables. | ||||
PAPEROPT_a4 = -D latex_paper_size=a4 | ||||
PAPEROPT_letter = -D latex_paper_size=letter | ||||
Fernando Perez
|
r1850 | ALLSPHINXOPTS = -d build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SRCDIR) | ||
Brian E Granger
|
r1256 | |||
Fernando Perez
|
r1850 | .PHONY: help clean html web pickle htmlhelp latex changes linkcheck api | ||
Brian E Granger
|
r1256 | |||
Fernando Perez
|
r2339 | default: html | ||
Brian E Granger
|
r1256 | help: | ||
@echo "Please use \`make <target>' where <target> is one of" | ||||
Paul Ivanov
|
r12940 | @echo " html standalone HTML files" | ||
@echo " html_noapi same as above, without the time consuming API docs" | ||||
@echo " pickle pickle files (usable by e.g. sphinx-web)" | ||||
@echo " htmlhelp HTML files and a HTML help project" | ||||
@echo " latex LaTeX files, you can set PAPER=a4 or PAPER=letter" | ||||
@echo " texinfo Texinfo files" | ||||
@echo " info Texinfo files and run them through makeinfo" | ||||
@echo " changes an overview over all changed/added/deprecated items" | ||||
@echo " linkcheck check all external links for integrity (takes a long time)" | ||||
Fernando Perez
|
r1525 | @echo | ||
@echo "Compound utility targets:" | ||||
@echo "pdf latex and then runs the PDF generation" | ||||
@echo "all html and pdf" | ||||
@echo "dist all, and then puts the results in dist/" | ||||
Fernando Perez
|
r2599 | @echo "gitwash-update update git workflow from source repo" | ||
Brian E Granger
|
r1256 | |||
Thomas Kluyver
|
r13458 | clean_api: | ||
-rm -rf $(SRCDIR)/api/generated | ||||
clean: clean_api | ||||
-rm -rf build/* dist/* | ||||
Brian E Granger
|
r1256 | |||
Fernando Perez
|
r1525 | pdf: latex | ||
cd build/latex && make all-pdf | ||||
all: html pdf | ||||
Fernando Perez
|
r4453 | # For final distribution, only build HTML (our pdf is now so large as to be | ||
# unusable, takes forever to build and just bloats the downloads). We leave | ||||
# them hardlinked at the top-level so users find them easily, though the | ||||
# original build/html dir is left in-place (useful to reload builds while | ||||
# testing). | ||||
dist: html | ||||
rm -rf html | ||||
cp -al build/html . | ||||
@echo "Build finished. Final docs are in html/" | ||||
Fernando Perez
|
r1525 | |||
Dav Clark
|
r12551 | html: api | ||
Thomas Kluyver
|
r13458 | html_noapi: clean_api | ||
Dav Clark
|
r12532 | |||
Dav Clark
|
r12551 | html html_noapi: | ||
Brian E Granger
|
r1256 | mkdir -p build/html build/doctrees | ||
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) build/html | ||||
@echo | ||||
@echo "Build finished. The HTML pages are in build/html." | ||||
Paul Ivanov
|
r11758 | api: source/api/generated/gen.txt | ||
Fernando Perez
|
r2535 | |||
Paul Ivanov
|
r11758 | source/api/generated/gen.txt: | ||
Fernando Perez
|
r1850 | python autogen_api.py | ||
@echo "Build API docs finished." | ||||
Brian E Granger
|
r1256 | pickle: | ||
mkdir -p build/pickle build/doctrees | ||||
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) build/pickle | ||||
@echo | ||||
@echo "Build finished; now you can process the pickle files or run" | ||||
@echo " sphinx-web build/pickle" | ||||
@echo "to start the sphinx-web server." | ||||
web: pickle | ||||
htmlhelp: | ||||
mkdir -p build/htmlhelp build/doctrees | ||||
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) build/htmlhelp | ||||
@echo | ||||
@echo "Build finished; now you can run HTML Help Workshop with the" \ | ||||
".hhp project file in build/htmlhelp." | ||||
Rustam Safin
|
r8944 | qthelp: | ||
mkdir -p build/qthelp | ||||
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) build/qthelp | ||||
@echo | ||||
@echo "Build finished; now you can run "qcollectiongenerator" with the" \ | ||||
".qhcp project file in $(BUILDDIR)/qthelp, like this:" | ||||
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/IPython.qhcp" | ||||
@echo "To view the help file:" | ||||
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/IPython.qhc" | ||||
Fernando Perez
|
r2535 | latex: api | ||
Brian E Granger
|
r1256 | mkdir -p build/latex build/doctrees | ||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) build/latex | ||||
@echo | ||||
@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." | ||||
changes: | ||||
mkdir -p build/changes build/doctrees | ||||
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) build/changes | ||||
@echo | ||||
@echo "The overview file is in build/changes." | ||||
linkcheck: | ||||
mkdir -p build/linkcheck build/doctrees | ||||
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) build/linkcheck | ||||
@echo | ||||
@echo "Link check complete; look for any errors in the above output " \ | ||||
Paul Ivanov
|
r11730 | "or in build/linkcheck/output.rst." | ||
Fernando Perez
|
r2599 | |||
gitwash-update: | ||||
python ../tools/gitwash_dumper.py source/development ipython | ||||
Fernando Perez
|
r2735 | |||
nightly: dist | ||||
Fernando Perez
|
r2893 | rsync -avH --delete dist/ ipython:www/doc/nightly | ||
MinRK
|
r3255 | |||
MinRK
|
r4672 | gh-pages: clean html | ||
MinRK
|
r3311 | python gh-pages.py | ||
Takafumi Arakaki
|
r10009 | |||
texinfo: | ||||
mkdir -p $(BUILDDIR)/texinfo | ||||
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo | ||||
@echo | ||||
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." | ||||
@echo "Run \`make' in that directory to run these through makeinfo" \ | ||||
"(use \`make info' here to do that automatically)." | ||||
info: | ||||
mkdir -p $(BUILDDIR)/texinfo | ||||
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo | ||||
@echo "Running Texinfo files through makeinfo..." | ||||
make -C $(BUILDDIR)/texinfo info | ||||
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." | ||||