git.m6w6.name Git - m6w6/libmemcached/blob - docs/include.am

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