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# the i18n builder cannot share the environment and doctrees with the others 15I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source 16 17.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext 18 19help: 20 @echo "Please use \`make <target>' where <target> is one of" 21 @echo " html to make standalone HTML files" 22 @echo " dirhtml to make HTML files named index.html in directories" 23 @echo " singlehtml to make a single large HTML file" 24 @echo " pickle to make pickle files" 25 @echo " json to make JSON files" 26 @echo " htmlhelp to make HTML files and a HTML help project" 27 @echo " qthelp to make HTML files and a qthelp project" 28 @echo " devhelp to make HTML files and a Devhelp project" 29 @echo " epub to make an epub" 30 @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" 31 @echo " latexpdf to make LaTeX files and run them through pdflatex" 32 @echo " text to make text files" 33 @echo " man to make manual pages" 34 @echo " texinfo to make Texinfo files" 35 @echo " info to make Texinfo files and run them through makeinfo" 36 @echo " gettext to make PO message catalogs" 37 @echo " changes to make an overview of all changed/added/deprecated items" 38 @echo " linkcheck to check all external links for integrity" 39 @echo " doctest to run all doctests embedded in the documentation (if enabled)" 40 41clean: 42 -rm -rf $(BUILDDIR)/* 43 44site: html epub latexpdf 45 -mkdir build/html/_files 46 -cp build/epub/MAMEDocumentation.epub build/html/_files/MAME.epub 47 -cp build/latex/MAME.pdf build/html/_files/MAME.pdf 48 49html: 50 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html 51 @echo 52 @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." 53 54dirhtml: 55 $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml 56 @echo 57 @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." 58 59singlehtml: 60 $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml 61 @echo 62 @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." 63 64pickle: 65 $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle 66 @echo 67 @echo "Build finished; now you can process the pickle files." 68 69json: 70 $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json 71 @echo 72 @echo "Build finished; now you can process the JSON files." 73 74htmlhelp: 75 $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp 76 @echo 77 @echo "Build finished; now you can run HTML Help Workshop with the" \ 78 ".hhp project file in $(BUILDDIR)/htmlhelp." 79 80qthelp: 81 $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp 82 @echo 83 @echo "Build finished; now you can run "qcollectiongenerator" with the" \ 84 ".qhcp project file in $(BUILDDIR)/qthelp, like this:" 85 @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/SphinxRTDthemedemo.qhcp" 86 @echo "To view the help file:" 87 @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/SphinxRTDthemedemo.qhc" 88 89devhelp: 90 $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp 91 @echo 92 @echo "Build finished." 93 @echo "To view the help file:" 94 @echo "# mkdir -p $$HOME/.local/share/devhelp/SphinxRTDthemedemo" 95 @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/SphinxRTDthemedemo" 96 @echo "# devhelp" 97 98epub: 99 $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub 100 @echo 101 @echo "Build finished. The epub file is in $(BUILDDIR)/epub." 102 103latex: 104 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex 105 @echo 106 @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." 107 @echo "Run \`make' in that directory to run these through (pdf)latex" \ 108 "(use \`make latexpdf' here to do that automatically)." 109 110latexpdf: 111 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex 112 @echo "Running LaTeX files through pdflatex..." 113 $(MAKE) -C $(BUILDDIR)/latex all-pdf 114 @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." 115 116text: 117 $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text 118 @echo 119 @echo "Build finished. The text files are in $(BUILDDIR)/text." 120 121man: 122 $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man 123 @echo 124 @echo "Build finished. The manual pages are in $(BUILDDIR)/man." 125 126texinfo: 127 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo 128 @echo 129 @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." 130 @echo "Run \`make' in that directory to run these through makeinfo" \ 131 "(use \`make info' here to do that automatically)." 132 133info: 134 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo 135 @echo "Running Texinfo files through makeinfo..." 136 make -C $(BUILDDIR)/texinfo info 137 @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." 138 139gettext: 140 $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale 141 @echo 142 @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." 143 144changes: 145 $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes 146 @echo 147 @echo "The overview file is in $(BUILDDIR)/changes." 148 149linkcheck: 150 $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck 151 @echo 152 @echo "Link check complete; look for any errors in the above output " \ 153 "or in $(BUILDDIR)/linkcheck/output.txt." 154 155doctest: 156 $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest 157 @echo "Testing of doctests in the sources finished, look at the " \ 158 "results in $(BUILDDIR)/doctest/output.txt." 159