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