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
  24
  25 if HAVE_RECENT_SPHINX
  26
  27 man_MANS+= \
  28            docs/man/hashkit_create.3 \
  29            docs/man/hashkit_functions.3 \
  30            docs/man/hashkit_value.3 \
  31            docs/man/libmemcached_examples.3 \
  32            docs/man/libmemcached.3 \
  33            docs/man/libmemcachedutil.3 \
  34            docs/man/memcached_analyze.3 \
  35            docs/man/memcached_auto.3 \
  36            docs/man/memcached_behavior.3 \
  37            docs/man/memcached_callback.3 \
  38            docs/man/memcached_create.3 \
  39            docs/man/memcached_delete.3 \
  40            docs/man/memcached_dump.3 \
  41            docs/man/memcached_flush_buffers.3 \
  42            docs/man/memcached_flush.3 \
  43            docs/man/memcached_generate_hash_value.3 \
  44            docs/man/memcached_get.3 \
  45            docs/man/memcached_memory_allocators.3 \
  46            docs/man/memcached_pool.3 \
  47            docs/man/memcached_quit.3 \
  48            docs/man/memcached_result_st.3 \
  49            docs/man/memcached_sasl.3 \
  50            docs/man/memcached_servers.3 \
  51            docs/man/memcached_server_st.3 \
  52            docs/man/memcached_set.3 \
  53            docs/man/memcached_stats.3 \
  54            docs/man/memcached_strerror.3 \
  55            docs/man/memcached_user_data.3 \
  56            docs/man/memcached_verbosity.3 \
  57            docs/man/memcached_version.3 \
  58            docs/man/memcapable.1 \
  59            docs/man/memcat.1 \
  60            docs/man/memcp.1 \
  61            docs/man/memdump.1 \
  62            docs/man/memerror.1 \
  63            docs/man/memflush.1 \
  64            docs/man/memrm.1 \
  65            docs/man/memslap.1 \
  66            docs/man/memstat.1
  67
  68 DISTCLEANFILES+= \
  69                  docs/man/hashkit_create.3 \
  70                  docs/man/hashkit_functions.3 \
  71                  docs/man/hashkit_value.3 \
  72                  docs/man/libmemcached_examples.3 \
  73                  docs/man/libmemcached.3 \
  74                  docs/man/libmemcachedutil.3 \
  75                  docs/man/memcached_analyze.3 \
  76                  docs/man/memcached_auto.3 \
  77                  docs/man/memcached_behavior.3 \
  78                  docs/man/memcached_callback.3 \
  79                  docs/man/memcached_create.3 \
  80                  docs/man/memcached_delete.3 \
  81                  docs/man/memcached_dump.3 \
  82                  docs/man/memcached_flush_buffers.3 \
  83                  docs/man/memcached_flush.3 \
  84                  docs/man/memcached_generate_hash_value.3 \
  85                  docs/man/memcached_get.3 \
  86                  docs/man/memcached_memory_allocators.3 \
  87                  docs/man/memcached_pool.3 \
  88                  docs/man/memcached_quit.3 \
  89                  docs/man/memcached_result_st.3 \
  90                  docs/man/memcached_sasl.3 \
  91                  docs/man/memcached_servers.3 \
  92                  docs/man/memcached_server_st.3 \
  93                  docs/man/memcached_set.3 \
  94                  docs/man/memcached_stats.3 \
  95                  docs/man/memcached_strerror.3 \
  96                  docs/man/memcached_user_data.3 \
  97                  docs/man/memcached_verbosity.3 \
  98                  docs/man/memcached_version.3 \
  99                  docs/man/memcapable.1 \
 100                  docs/man/memcat.1 \
 101                  docs/man/memcp.1 \
 102                  docs/man/memdump.1 \
 103                  docs/man/memerror.1 \
 104                  docs/man/memflush.1 \
 105                  docs/man/memrm.1 \
 106                  docs/man/memslap.1 \
 107                  docs/man/memstat.1
 108
 109 docs/man/hashkit_create.3: man
 110 docs/man/hashkit_functions.3: man
 111 docs/man/hashkit_value.3: man
 112 docs/man/libmemcached_examples.3: man
 113 docs/man/libmemcached.3: man
 114 docs/man/libmemcachedutil.3: man
 115 docs/man/memcached_analyze.3: man
 116 docs/man/memcached_auto.3: man
 117 docs/man/memcached_behavior.3: man
 118 docs/man/memcached_callback.3: man
 119 docs/man/memcached_create.3: man
 120 docs/man/memcached_delete.3: man
 121 docs/man/memcached_dump.3: man
 122 docs/man/memcached_flush_buffers.3: man
 123 docs/man/memcached_flush.3: man
 124 docs/man/memcached_generate_hash_value.3: man
 125 docs/man/memcached_get.3: man
 126 docs/man/memcached_memory_allocators.3: man
 127 docs/man/memcached_pool.3: man
 128 docs/man/memcached_quit.3: man
 129 docs/man/memcached_result_st.3: man
 130 docs/man/memcached_sasl.3: man
 131 docs/man/memcached_servers.3: man
 132 docs/man/memcached_server_st.3: man
 133 docs/man/memcached_set.3: man
 134 docs/man/memcached_stats.3: man
 135 docs/man/memcached_strerror.3: man
 136 docs/man/memcached_user_data.3: man
 137 docs/man/memcached_verbosity.3: man
 138 docs/man/memcached_version.3: man
 139 docs/man/memcapable.1: man
 140 docs/man/memcat.1: man
 141 docs/man/memcp.1: man
 142 docs/man/memdump.1: man
 143 docs/man/memerror.1: man
 144 docs/man/memflush.1: man
 145 docs/man/memrm.1: man
 146 docs/man/memslap.1: man
 147 docs/man/memstat.1: man
 148
 149 endif
 150
 151 if HAVE_SPHINX
 152 sphinx-help:
 153         @echo "Please use \`make <target>' where <target> is one of"
 154         @echo "  html       to make standalone HTML files"
 155         @echo "  dirhtml    to make HTML files named index.html in directories"
 156         @echo "  singlehtml to make a single large HTML file"
 157         @echo "  pickle     to make pickle files"
 158         @echo "  json       to make JSON files"
 159         @echo "  htmlhelp   to make HTML files and a HTML help project"
 160         @echo "  qthelp     to make HTML files and a qthelp project"
 161         @echo "  devhelp    to make HTML files and a Devhelp project"
 162         @echo "  epub       to make an epub"
 163         @echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
 164         @echo "  latexpdf   to make LaTeX files and run them through pdflatex"
 165         @echo "  text       to make text files"
 166         @echo "  man        to make manual pages"
 167         @echo "  changes    to make an overview of all changed/added/deprecated items"
 168         @echo "  linkcheck  to check all external links for integrity"
 169         @echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
 170
 171 html-local:
 172         PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/html
 173         @echo
 174         @echo "Build finished. The HTML pages are in $(SPHINX_BUILDDIR)/html."
 175
 176 dirhtml:
 177         PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/dirhtml
 178         @echo
 179         @echo "Build finished. The HTML pages are in $(SPHINX_BUILDDIR)/dirhtml."
 180
 181 singlehtml:
 182         PYTHONPATH=${top_srcdir}/docs  $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/singlehtml
 183         @echo
 184         @echo "Build finished. The HTML page is in $(SPHINX_BUILDDIR)/singlehtml."
 185
 186 pickle:
 187         PYTHONPATH=${top_srcdir}/docs  $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/pickle
 188         @echo
 189         @echo "Build finished; now you can process the pickle files."
 190
 191 json:
 192         PYTHONPATH=${top_srcdir}/docs  $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/json
 193         @echo
 194         @echo "Build finished; now you can process the JSON files."
 195
 196 htmlhelp:
 197         PYTHONPATH=${top_srcdir}/docs  $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/htmlhelp
 198         @echo
 199         @echo "Build finished; now you can run HTML Help Workshop with the" \
 200               ".hhp project file in $(SPHINX_BUILDDIR)/htmlhelp."
 201
 202 qthelp:
 203         PYTHONPATH=${top_srcdir}/docs  $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/qthelp
 204         @echo
 205         @echo "Build finished; now you can run "qcollectiongenerator" with the" \
 206               ".qhcp project file in $(SPHINX_BUILDDIR)/qthelp, like this:"
 207         @echo "# qcollectiongenerator $(SPHINX_BUILDDIR)/qthelp/Drizzle.qhcp"
 208         @echo "To view the help file:"
 209         @echo "# assistant -collectionFile $(SPHINX_BUILDDIR)/qthelp/Drizzle.qhc"
 210
 211 devhelp:
 212         PYTHONPATH=${top_srcdir}/docs  $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/devhelp
 213         @echo
 214         @echo "Build finished."
 215         @echo "To view the help file:"
 216         @echo "# mkdir -p $$HOME/.local/share/devhelp/Drizzle"
 217         @echo "# ln -s $(SPHINX_BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Drizzle"
 218         @echo "# devhelp"
 219
 220 epub:
 221         PYTHONPATH=${top_srcdir}/docs  $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/epub
 222         @echo
 223         @echo "Build finished. The epub file is in $(SPHINX_BUILDDIR)/epub."
 224
 225 latex:
 226         PYTHONPATH=${top_srcdir}/docs  $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/latex
 227         @echo
 228         @echo "Build finished; the LaTeX files are in $(SPHINX_BUILDDIR)/latex."
 229         @echo "Run \`make' in that directory to run these through (pdf)latex" \
 230               "(use \`make latexpdf' here to do that automatically)."
 231
 232 latexpdf: latex
 233         PYTHONPATH=${top_srcdir}/docs  $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/latex
 234         @echo "Running LaTeX files through pdflatex..."
 235         make -C $(SPHINX_BUILDDIR)/latex all-pdf
 236         @echo "pdflatex finished; the PDF files are in $(SPHINX_BUILDDIR)/latex."
 237
 238 text:
 239         PYTHONPATH=${top_srcdir}/docs  $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/text
 240         @echo
 241         @echo "Build finished. The text files are in $(SPHINX_BUILDDIR)/text."
 242
 243 man:
 244         PYTHONPATH=${top_srcdir}/docs  $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/man
 245         @echo
 246         @echo "Build finished. The manual pages are in $(SPHINX_BUILDDIR)/man."
 247
 248 changes:
 249         PYTHONPATH=${top_srcdir}/docs  $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/changes
 250         @echo
 251         @echo "The overview file is in $(SPHINX_BUILDDIR)/changes."
 252
 253 linkcheck:
 254         PYTHONPATH=${top_srcdir}/docs  $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/linkcheck
 255         @echo
 256         @echo "Link check complete; look for any errors in the above output " \
 257               "or in $(SPHINX_BUILDDIR)/linkcheck/output.txt."
 258
 259 doctest:
 260         PYTHONPATH=${top_srcdir}/docs  $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/doctest
 261         @echo "Testing of doctests in the sources finished, look at the " \
 262               "results in $(SPHINX_BUILDDIR)/doctest/output.txt."
 263 endif