SPHINXOPTS =

SPHINXBUILD = sphinx-build

PAPER =

PAPEROPT_a4 = -D latex_paper_size=a4

PAPEROPT_letter = -D latex_paper_size=letter

ALLSPHINXOPTS = -d build/doctrees$(PAPEROPT_$(PAPER))$(SPHINXOPTS) source

.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest

help:

@echo"Please use\`make <target>' where <target> is one of"

@echo" html to make standalone HTML files"

@echo" dirhtml to make HTML files named index.html in directories"

@echo" pickle to make pickle files"

@echo" json to make JSON files"

@echo" htmlhelp to make HTML files and a HTML help project"

@echo" qthelp to make HTML files and a qthelp project"

@echo" latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"

@echo" man to make manual pages"

@echo" changes to make an overview of all changed/added/deprecated items"

@echo" linkcheck to check all external links for integrity"

@echo" doctest to run all doctests embedded in the documentation (if enabled)"

clean:

-rm -rf build/*

html:

$(SPHINXBUILD) -b html$(ALLSPHINXOPTS) build/html

@echo

@echo"Build finished. The HTML pages are in build/html."

dirhtml:

$(SPHINXBUILD) -b dirhtml$(ALLSPHINXOPTS) build/dirhtml

@echo

@echo"Build finished. The HTML pages are in build/dirhtml."

pickle:

$(SPHINXBUILD) -b pickle$(ALLSPHINXOPTS) build/pickle

@echo

@echo"Build finished; now you can process the pickle files."

json:

$(SPHINXBUILD) -b json$(ALLSPHINXOPTS) build/json

@echo

@echo"Build finished; now you can process the JSON files."

htmlhelp:

$(SPHINXBUILD) -b htmlhelp$(ALLSPHINXOPTS) build/htmlhelp

@echo

@echo"Build finished; now you can run HTML Help Workshop with the"\

qthelp:

$(SPHINXBUILD) -b qthelp$(ALLSPHINXOPTS) build/qthelp

@echo

@echo"Build finished; now you can run"qcollectiongenerator" with the"\

@echo"# qcollectiongenerator build/qthelp/bpython.qhcp"

@echo"To view the help file:"

@echo"# assistant -collectionFile build/qthelp/bpython.qhc"

latex:

$(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"\

man:

$(SPHINXBUILD) -b man$(ALLSPHINXOPTS) build/man

@echo

@echo"Build finished; the manual pages are in build/man."

changes:

$(SPHINXBUILD) -b changes$(ALLSPHINXOPTS) build/changes

@echo

@echo"The overview file is in build/changes."

linkcheck:

$(SPHINXBUILD) -b linkcheck$(ALLSPHINXOPTS) build/linkcheck

@echo

@echo"Link check complete; look for any errors in the above output"\

doctest:

$(SPHINXBUILD) -b doctest$(ALLSPHINXOPTS) build/doctest

@echo"Testing of doctests in the sources finished, look at the"\