doc/Makefile

   1 # Makefile for Sphinx documentation
   2 #
   3
   4 # You can set these variables from the command line.
   5 SPHINXOPTS    = -q
   6 SPHINXBUILD   = sphinx-build
   7
   8 INDIR         = .
   9 HTMLDIR       = build/html
  10
  11 # Internal variables.
  12 ALLSPHINXOPTS   = -d build/doctrees $(SPHINXOPTS) $(INDIR)
  13
  14 .PHONY: examples help clean html web pickle htmlhelp latex changes linkcheck
  15
  16 logo/pylit-bold-framed.png: logo/pylit-bold-framed.svg
  17         inkscape --export-png=logo/pylit-bold-framed.png logo/pylit-bold-framed.svg
  18
  19 examples/pylit.py.txt: ../pylit.py
  20         pylit ../pylit.py examples/pylit.py.txt
  21
  22 examples/pylit_test.py.txt: ../test/pylit_test.py
  23         pylit --comment-string='## ' ../test/pylit_test.py examples/pylit_test.py.txt
  24
  25 examples/conf.py.txt: conf.py
  26         pylit conf.py examples/conf.py.txt
  27
  28 examples: examples/pylit.py.txt examples/pylit_test.py.txt examples/conf.py.txt
  29
  30 help:
  31         @echo "Please use \`make <target>' where <target> is one of"
  32         @echo "  html      to make standalone HTML files"
  33         @echo "  pickle    to make pickle files"
  34         @echo "  json      to make JSON files"
  35         @echo "  htmlhelp  to make HTML files and a HTML help project"
  36         @echo "  latex     to make LaTeX files"
  37         @echo "  changes   to make an overview over all changed/added/deprecated items"
  38         @echo "  linkcheck to check all external links for integrity"
  39
  40 clean:
  41         -rm -rf build/*
  42
  43 html:   examples logo/pylit-bold-framed.png
  44         echo $(INDIR)
  45         mkdir -p $(HTMLDIR) build/doctrees
  46         $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(HTMLDIR)
  47         @echo
  48         @echo "Copying some source files"
  49         cp $(INDIR)/download/pylit $(HTMLDIR)/download/
  50         # cp $(INDIR)/examples/*.txt $(HTMLDIR)/examples/
  51         # cp $(INDIR)/examples/*.py  $(HTMLDIR)/examples/
  52         # cp $(INDIR)/examples/*.sty $(HTMLDIR)/examples/
  53         # cp $(INDIR)/examples/*.css $(HTMLDIR)/examples/
  54         cp $(INDIR)/tutorial/*.py  $(HTMLDIR)/tutorial/
  55         cp $(INDIR)/tutorial/*.py.txt $(HTMLDIR)/tutorial/
  56
  57         @echo
  58         @echo "Build finished. The HTML pages are in $(HTMLDIR)."
  59
  60 pickle:
  61         mkdir -p build/pickle build/doctrees
  62         $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) build/pickle
  63         @echo
  64         @echo "Build finished; now you can process the pickle files."
  65
  66 web: pickle
  67
  68 json:
  69         mkdir -p build/json build/doctrees
  70         $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) build/json
  71         @echo
  72         @echo "Build finished; now you can process the JSON files."
  73
  74 htmlhelp:
  75         mkdir -p build/htmlhelp build/doctrees
  76         $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) build/htmlhelp
  77         @echo
  78         @echo "Build finished; now you can run HTML Help Workshop with the" \
  79               ".hhp project file in build/htmlhelp."
  80
  81 latex:
  82         mkdir -p build/latex build/doctrees
  83         $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) build/latex
  84         @echo
  85         @echo "Build finished; the LaTeX files are in build/latex."
  86         @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
  87               "run these through (pdf)latex."
  88
  89 changes:
  90         mkdir -p build/changes build/doctrees
  91         $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) build/changes
  92         @echo
  93         @echo "The overview file is in build/changes."
  94
  95 linkcheck:
  96         mkdir -p build/linkcheck build/doctrees
  97         $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) build/linkcheck
  98         @echo
  99         @echo "Link check complete; look for any errors in the above output " \
 100               "or in build/linkcheck/output.txt."