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