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