You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

Makefile 7.3KB

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