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