ryu/doc/Makefile

   1 # Makefile for Sphinx documentation
   2 #
   3
   4 export PYTHONPATH = $PYTHONPATH:..
   5
   6 # You can set these variables from the command line.
   7 SPHINXOPTS    =
   8 SPHINXBUILD   = sphinx-build
   9 PAPER         =
  10 BUILDDIR      = build
  11
  12 # Internal variables.
  13 PAPEROPT_a4     = -D latex_paper_size=a4
  14 PAPEROPT_letter = -D latex_paper_size=letter
  15 ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
  16
  17 .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
  18
  19 help:
  20         @echo "Please use \`make <target>' where <target> is one of"
  21         @echo "  html       to make standalone HTML files"
  22         @echo "  dirhtml    to make HTML files named index.html in directories"
  23         @echo "  singlehtml to make a single large HTML file"
  24         @echo "  pickle     to make pickle files"
  25         @echo "  json       to make JSON files"
  26         @echo "  htmlhelp   to make HTML files and a HTML help project"
  27         @echo "  qthelp     to make HTML files and a qthelp project"
  28         @echo "  devhelp    to make HTML files and a Devhelp project"
  29         @echo "  epub       to make an epub"
  30         @echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
  31         @echo "  latexpdf   to make LaTeX files and run them through pdflatex"
  32         @echo "  text       to make text files"
  33         @echo "  man        to make manual pages"
  34         @echo "  changes    to make an overview of all changed/added/deprecated items"
  35         @echo "  linkcheck  to check all external links for integrity"
  36         @echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
  37
  38 clean:
  39         -rm -rf $(BUILDDIR)/*
  40
  41 html:
  42         $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
  43         @echo
  44         @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
  45
  46 dirhtml:
  47         $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
  48         @echo
  49         @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
  50
  51 singlehtml:
  52         $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
  53         @echo
  54         @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
  55
  56 pickle:
  57         $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
  58         @echo
  59         @echo "Build finished; now you can process the pickle files."
  60
  61 json:
  62         $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
  63         @echo
  64         @echo "Build finished; now you can process the JSON files."
  65
  66 htmlhelp:
  67         $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
  68         @echo
  69         @echo "Build finished; now you can run HTML Help Workshop with the" \
  70               ".hhp project file in $(BUILDDIR)/htmlhelp."
  71
  72 qthelp:
  73         $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
  74         @echo
  75         @echo "Build finished; now you can run "qcollectiongenerator" with the" \
  76               ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
  77         @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/ryu.qhcp"
  78         @echo "To view the help file:"
  79         @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/ryu.qhc"
  80
  81 devhelp:
  82         $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
  83         @echo
  84         @echo "Build finished."
  85         @echo "To view the help file:"
  86         @echo "# mkdir -p $$HOME/.local/share/devhelp/ryu"
  87         @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/ryu"
  88         @echo "# devhelp"
  89
  90 epub:
  91         $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
  92         @echo
  93         @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
  94
  95 latex:
  96         $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
  97         @echo
  98         @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
  99         @echo "Run \`make' in that directory to run these through (pdf)latex" \
 100               "(use \`make latexpdf' here to do that automatically)."
 101
 102 latexpdf:
 103         $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
 104         @echo "Running LaTeX files through pdflatex..."
 105         $(MAKE) -C $(BUILDDIR)/latex all-pdf
 106         @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
 107
 108 text:
 109         $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
 110         @echo
 111         @echo "Build finished. The text files are in $(BUILDDIR)/text."
 112
 113 man:
 114         $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
 115         @echo
 116         @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
 117
 118 changes:
 119         $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
 120         @echo
 121         @echo "The overview file is in $(BUILDDIR)/changes."
 122
 123 linkcheck:
 124         $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
 125         @echo
 126         @echo "Link check complete; look for any errors in the above output " \
 127               "or in $(BUILDDIR)/linkcheck/output.txt."
 128
 129 doctest:
 130         $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
 131         @echo "Testing of doctests in the sources finished, look at the " \
 132               "results in $(BUILDDIR)/doctest/output.txt."