Makefile (6933B)
1 # Makefile for Sphinx documentation 2 # 3 4 # You can set these variables from the command line. 5 SPHINXOPTS = 6 SPHINXBUILD = sphinx-build 7 PAPER = 8 BUILDDIR = _build 9 10 # User-friendly check for sphinx-build 11 ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) 12 $(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/) 13 endif 14 15 # Internal variables. 16 PAPEROPT_a4 = -D latex_paper_size=a4 17 PAPEROPT_letter = -D latex_paper_size=letter 18 ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . 19 # the i18n builder cannot share the environment and doctrees with the others 20 I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . 21 22 .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext 23 24 help: 25 @echo "Please use \`make <target>' where <target> is one of" 26 @echo " html to make standalone HTML files" 27 @echo " dirhtml to make HTML files named index.html in directories" 28 @echo " singlehtml to make a single large HTML file" 29 @echo " pickle to make pickle files" 30 @echo " json to make JSON files" 31 @echo " htmlhelp to make HTML files and a HTML help project" 32 @echo " qthelp to make HTML files and a qthelp project" 33 @echo " devhelp to make HTML files and a Devhelp project" 34 @echo " epub to make an epub" 35 @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" 36 @echo " latexpdf to make LaTeX files and run them through pdflatex" 37 @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" 38 @echo " text to make text files" 39 @echo " man to make manual pages" 40 @echo " texinfo to make Texinfo files" 41 @echo " info to make Texinfo files and run them through makeinfo" 42 @echo " gettext to make PO message catalogs" 43 @echo " changes to make an overview of all changed/added/deprecated items" 44 @echo " xml to make Docutils-native XML files" 45 @echo " pseudoxml to make pseudoxml-XML files for display purposes" 46 @echo " linkcheck to check all external links for integrity" 47 @echo " doctest to run all doctests embedded in the documentation (if enabled)" 48 49 clean: 50 rm -rf $(BUILDDIR)/* 51 52 # The html-linked builder does not support caching, so we 53 # remove all cached state first. 54 html: 55 # -W = exit 1 on warning; --keep-going = complete build anyway; -w /tmp/sphinx-warnings.log = write log to ~/warnings.log 56 $(SPHINXBUILD) -b html-linked $(ALLSPHINXOPTS) $(BUILDDIR)/html 57 @echo 58 @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." 59 60 dirhtml: 61 $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml 62 @echo 63 @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." 64 65 singlehtml: 66 $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml 67 @echo 68 @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." 69 70 pickle: 71 $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle 72 @echo 73 @echo "Build finished; now you can process the pickle files." 74 75 json: 76 $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json 77 @echo 78 @echo "Build finished; now you can process the JSON files." 79 80 htmlhelp: 81 $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp 82 @echo 83 @echo "Build finished; now you can run HTML Help Workshop with the" \ 84 ".hhp project file in $(BUILDDIR)/htmlhelp." 85 86 qthelp: 87 $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp 88 @echo 89 @echo "Build finished; now you can run "qcollectiongenerator" with the" \ 90 ".qhcp project file in $(BUILDDIR)/qthelp, like this:" 91 @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/neuro.qhcp" 92 @echo "To view the help file:" 93 @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/neuro.qhc" 94 95 devhelp: 96 $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp 97 @echo 98 @echo "Build finished." 99 @echo "To view the help file:" 100 @echo "# mkdir -p $$HOME/.local/share/devhelp/neuro" 101 @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/neuro" 102 @echo "# devhelp" 103 104 epub: 105 $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub 106 @echo 107 @echo "Build finished. The epub file is in $(BUILDDIR)/epub." 108 109 latex: 110 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex 111 @echo 112 @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." 113 @echo "Run \`make' in that directory to run these through (pdf)latex" \ 114 "(use \`make latexpdf' here to do that automatically)." 115 116 latexpdf: 117 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex 118 @echo "Running LaTeX files through pdflatex..." 119 $(MAKE) -C $(BUILDDIR)/latex all-pdf 120 @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." 121 122 latexpdfja: 123 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex 124 @echo "Running LaTeX files through platex and dvipdfmx..." 125 $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja 126 @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." 127 128 text: 129 $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text 130 @echo 131 @echo "Build finished. The text files are in $(BUILDDIR)/text." 132 133 man: 134 $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man 135 @echo 136 @echo "Build finished. The manual pages are in $(BUILDDIR)/man." 137 138 texinfo: 139 $(SPHINXBUILD) -b texinfo . $(BUILDDIR)/texinfo ./index.rst -D master_doc=index 140 @echo 141 @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo" 142 @echo "Run \`make' in that directory to run these through makeinfo" 143 144 info: 145 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo 146 @echo "Running Texinfo files through makeinfo..." 147 make -C $(BUILDDIR)/texinfo info 148 @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." 149 150 gettext: 151 $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale 152 @echo 153 @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." 154 155 changes: 156 $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes 157 @echo 158 @echo "The overview file is in $(BUILDDIR)/changes." 159 160 linkcheck: 161 $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck 162 @echo 163 @echo "Link check complete; look for any errors in the above output " \ 164 "or in $(BUILDDIR)/linkcheck/output.txt." 165 166 doctest: 167 $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest 168 @echo "Testing of doctests in the sources finished, look at the " \ 169 "results in $(BUILDDIR)/doctest/output.txt." 170 171 xml: 172 $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml 173 @echo 174 @echo "Build finished. The XML files are in $(BUILDDIR)/xml." 175 176 pseudoxml: 177 $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml 178 @echo 179 @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."