Makefile for Sphinx documentation

Amoy to a makefile, back up a bit.

# makefile for sphinx documentation## you can set these variables  from the command line. sphinxopts    =sphinxbuild   = sphinx-buildpaper          =BUILDDIR      = build#  user-friendly check for sphinx-buildifeq  ($ (shell which $ (SPHINXBUILD)  > /dev/null 2>&1; echo $$,  1) $ (error the  ' $ (sphinxbuild) '  command  was not found. make sure you have sphinx installed, then  set the SPHINXBUILD environment variable to point to the  full path of the  ' $ (sphinxbuild) '  executable. alternatively you can  add the directory with the executable to your path.  If you don ' t have sphinx installed, grab it from http:// sphinx-doc.org/) Endif# internal variables. paperopt_a4     = -d latex_paper_size=a4paperopt_letter = -d  latex_paper_size=letterallsphinxopts   = -d $ (BUILDDIR)/doctrees $ ( paperopt_$ (PAPER))  $ (sphinxopts)  source# the i18n builder cannot share  the environment and doctrees with the othersi18nsphinxopts  =  $ (paperopt_$ (PAPER))  $ (sphinxopts)  source. phony: help clean html dirhtml singlehtml pickle json htmlhelp  qthelp devhelp epub latex latexpdf text man changes linkcheck  doctest gettexthelp:    @echo   "please use \ ' make <target> '   Where <target> is one&nBsp;of "    @echo  "   html       to make  standalone html files "    @echo  "   dirhtml     to make html files named index.html in directories "    @echo   "  singlehtml to make a single large html file"      @echo   "  pickle     to make pickle files"     @echo   "  json       to make json  files "    @echo  "   htmlhelp   to make HTML  Files and a html help project "    @echo  "   qthelp      to make html files and a qthelp project "     @echo   "  devhelp    to make html files and a devhelp  Project     @echo     epub       to make  an epub "    @echo  "   latex      to  Make latex files, you can set paper=a4 or paper=letter "     @echo   "  latexpdf   to make latex files and run  them through pdflatex "    @echo  "   latexpdfja to make &NBSP;LATEX&NBSP;FILES&NBSP;AND&NBSP;RUN&NBSP;THEM&NBSP;THROUGH&NBSP;PLATEX/DVIPDFMX "    @echo   "  text       to make text files"      @echo     man        to make  Manual pages "    @echo   "  texinfo    to make texinfo files"      @echo     info       to make Texinfo  Files and run them through makeinfo "    @echo  "   gettext     to make po message catalogs "    @echo  "    changes    to make an overview of all changed/added/ Deprecated items "    @echo  "   xml         to make docutils-native xml files "    @echo  "    Pseudoxml  to make pseudoxml-xml files for display purposes "     @echo     linkcheck  to check all external links  For integrity "    @echo   "  doctest    to run all doctests embedded  in the documentation  (if enabled) "clean:   rm -rf $ ( BUILDDIR)/*html:   $ (sphinxbuild)  -b html $ (allsphinxopts)  $ (BUILDDIR)/html     @echo     @echo   "build finished. the html pages  are in $ (BUILDDIR)/html. " dirhtml:   $ (Sphinxbuild)  -b dirhtml $ (allsphinxopts)  $ (BUILDDIR)/dirhtml     @echo     @echo   "build finished. the html pages  are in $ (BUILDDIR)/dirhtml. " singlehtml:   $ (Sphinxbuild)  -b singlehtml $ (allsphinxopts)  $ (BUILDDIR)/ singlehtml    @echo     @echo   "build finished. the html  page is in $ (BUILDDIR)/singlehtml. " pickle:    $ (Sphinxbuild)  -b pickle $ (allsphinxopts)  $ (BUILDDIR)/pickle    @echo     @echo   "build finished; now you can process the  Pickle files. " json:   $ (Sphinxbuild)  -b json $ (allsphinxopts)  $ (BUILDDIR)/json     @echo     @echo   "build finished; now you can process  the json files. " htmlhelp:   $ (Sphinxbuild)  -b htmlhelp $ (allsphinxopts)  $ (BUILDDIR)/ htmlhelp    @echo     @echo   "Build finished; now you can  run html help workshop with the "            ". hhp project file in $ (BUILDDIR)/htmlhelp." qthelp:   $ (Sphinxbuild)  -b qthelp $ (allsphinxopts)  $ (BUILDDIR)/qthelp    @echo    @echo   "build finished; now you can run " Qcollectiongenerator " with the"            ". Qhcp  project file in $ (BUILDDIR)/qthelp, like this: "    @echo  " #  qcollectiongenerator $ (BUILDDIR)/qthelp/ceph-deploy.qhcp "    @echo  " To view  the help file: "    @echo  " # assistant -collectionfile $ ( BUILDDIR)/QTHELP/CEPH-DEPLOY.QHC "devhelp:   $ (sphinxbuild)  -b devhelp $ ( allsphinxopts)  $ (BUILDDIR)/devhelp    @echo     @echo   "build  Finished. "     @echo   "to view the help file:"     @echo   "#  mkdir -p $ $HOME/.local/share/devhelp/ceph-deploy "    @echo  " # ln -s  $ (BUILDDIR)/devhelp $ $HOME/.LOcal/share/devhelp/ceph-deploy "    @echo  " # devhelp "epub:   $ ( Sphinxbuild)  -b epub $ (allsphinxopts)  $ (BUILDDIR)/epub    @echo      @echo   "build finished. the epub file is in $ (BUILDDIR)/epub." latex:   $ (Sphinxbuild)  -b latex $ (allsphinxopts)  $ (BUILDDIR)/latex     @echo     @echo   "Build finished; the latex files are  in $ (BUILDDIR)/latex. "     @echo   "run \ ' Make '  in that directory to run these  through  (pdf) Latex "          " (use \ ' make  latexpdf '  here to do that automatically). " latexpdf:   $ (Sphinxbuild)  -b latex $ (allsphinxopts)  $ (BUILDDIR)/latex     @echo   "running Latex files through pdflatex ... "   $ (make)  -c $ (BUILDDIR)/latex  all-pdf    @echo   "Pdflatex finished; the pdf files are in  $ (BUILDDIR)/latex. " latexpdfja:   $ (Sphinxbuild)  -b latex $ (allsphinxopts)  $ (BUILDDIR)/latex     @echo   "RUNNING&NBSP;LATEX&NBSP;FILES&NBSP;THROUGH&NBSP;PLATEX&NBSP;AND&NBSP;DVIPDFMX ... "   $ (Make)  -c $ (BUILDDIR)/latex all-pdf-ja    @echo  " pdflatex finished; the pdf files are in $ (BUILDDIR)/latex. " text:   $ (Sphinxbuild)  -b text $ (allsphinxopts)  $ (BUILDDIR)/text     @echo     @echo   "Build finished. the text files are  in $ (BUILDDIR)/text. " man:   $ (Sphinxbuild)  -b man $ (allsphinxopts)  $ (BUILDDIR)/man    @echo     @echo   "Build finished. the manual pages are  in $ (BUILDDIR)/man. " texinfo:   $ (Sphinxbuild)  -b texinfo $ (allsphinxopts)  $ (BUILDDIR)/texinfo     @echo     @echo   "Build finished. the texinfo files  are in $ (BUILDDIR)/texinfo. "     @echo   "run \ ' Make '  in that directory to run these  through makeinfo "          " (use \ ' make  info '  here to do that automatically). " info:   $ (Sphinxbuild)  -b texinfo $ (allsphinxopts)  $ (BUILDDIR)/texinfo     @echo   "Running texinfo files through makeinfo ..."     make -c $ (BUILDDIR)/texinfo info    @echo   "makeinfo finished; the info files are in $ (BUILDDIR)/texinfo. " gettext:   $ (Sphinxbuild)  -b gettext $ (i18nsphinxopts)  $ (BUILDDIR)/locale     @echo     @echo   "Build finished. the message catalogs  are in $ (BUILDDIR)/locale. " changes:   $ (Sphinxbuild)  -b changes $ (allsphinxopts)  $ (BUILDDIR)/changes     @echo     @echo   "the overview file is in $ ( BUILDDIR)/changes. " linkcheck:   $ (Sphinxbuild)  -b linkcheck $ (allsphinxopts)  $ (BUILDDIR)/ linkcheck    @echo     @echo   "link check complete; look  for any errors in the above output  "            "or in $ (BUILDDIR)/linkcheck/output.txt." doctest:   $ (Sphinxbuild)  -b doctest $ (allsphinxopts)  $ (BUILDDIR)/doctest    @echo   "Testing of  doctests in the sources finished, look at the  "            "results in $ (BUILDDIR)/doctest/output.txt." xml:   $ (Sphinxbuild)  -b xml $ (allsphinxopts)  $ (BUILDDIR)/xml     @echo     @echo   "Build finished. the xml files are in  $ (BUILDDIR)/xml. " pseudoxml:   $ (Sphinxbuild)  -b pseudoxml $ (allsphinxopts)  $ (BUILDDIR)/ pseudoxml    @echo     @echo   "Build finished. the pseudo-xml  files are in $ (BUILDDIR)/pseudoxml. "

Makefile for Sphinx documentation