src/native_client_sdk/src/doc/Makefile

   1 # Makefile for Sphinx documentation
   2 #
   3
   4 # You can set these variables from the command line.
   5 SPHINXOPTS    = -W
   6 SPHINXBUILD   = sphinx-build
   7 PAPER         =
   8 BUILDDIR      = _build
   9 CHROMESITE_BUILDDIR = $(realpath ../../doc_generated)
  10
  11 # User-friendly check for sphinx-build
  12 ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
  13 $(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/)
  14 endif
  15
  16 # Internal variables.
  17 PAPEROPT_a4     = -D latex_paper_size=a4
  18 PAPEROPT_letter = -D latex_paper_size=letter
  19 ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
  20 # the i18n builder cannot share the environment and doctrees with the others
  21 I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
  22
  23 .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext all
  24
  25 all: chromesite
  26
  27 help:
  28         @echo "Please use \`make <target>' where <target> is one of"
  29         @echo "  html         to make standalone HTML files"
  30         @echo "  dirhtml      to make HTML files named index.html in directories"
  31         @echo "  singlehtml   to make a single large HTML file"
  32         @echo "  pickle       to make pickle files"
  33         @echo "  json         to make JSON files"
  34         @echo "  htmlhelp     to make HTML files and a HTML help project"
  35         @echo "  qthelp       to make HTML files and a qthelp project"
  36         @echo "  devhelp      to make HTML files and a Devhelp project"
  37         @echo "  epub         to make an epub"
  38         @echo "  latex        to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
  39         @echo "  latexpdf     to make LaTeX files and run them through pdflatex"
  40         @echo "  latexpdfja   to make LaTeX files and run them through platex/dvipdfmx"
  41         @echo "  text         to make text files"
  42         @echo "  man          to make manual pages"
  43         @echo "  texinfo      to make Texinfo files"
  44         @echo "  info         to make Texinfo files and run them through makeinfo"
  45         @echo "  gettext      to make PO message catalogs"
  46         @echo "  changes      to make an overview of all changed/added/deprecated items"
  47         @echo "  xml          to make Docutils-native XML files"
  48         @echo "  pseudoxml    to make pseudoxml-XML files for display purposes"
  49         @echo "  linkcheck    to check all external links for integrity"
  50         @echo "  doctest      to run all doctests embedded in the documentation (if enabled)"
  51         @echo "  devsite      build locally viewable version of docs for developers.google.com"
  52         @echo "  devsite-prod build production docs for developers.google.com"
  53         @echo "  serve        start python web server on port server 8009"
  54         @echo "  chromesite   build docs for developer.chrome.com"
  55         @echo "  chromesite_rst    only build .rst docs; no doxygen"
  56         @echo "  serve_chromesite  start python web server for chromesite docs"
  57
  58 clean:
  59         rm -rf $(BUILDDIR)/*
  60
  61 html:
  62         $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
  63         @echo
  64         @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
  65
  66 dirhtml:
  67         $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
  68         @echo
  69         @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
  70
  71 singlehtml:
  72         $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
  73         @echo
  74         @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
  75
  76 pickle:
  77         $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
  78         @echo
  79         @echo "Build finished; now you can process the pickle files."
  80
  81 json:
  82         $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
  83         @echo
  84         @echo "Build finished; now you can process the JSON files."
  85
  86 htmlhelp:
  87         $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
  88         @echo
  89         @echo "Build finished; now you can run HTML Help Workshop with the" \
  90               ".hhp project file in $(BUILDDIR)/htmlhelp."
  91
  92 qthelp:
  93         $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
  94         @echo
  95         @echo "Build finished; now you can run "qcollectiongenerator" with the" \
  96               ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
  97         @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/NativeClient.qhcp"
  98         @echo "To view the help file:"
  99         @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/NativeClient.qhc"
 100
 101 devhelp:
 102         $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
 103         @echo
 104         @echo "Build finished."
 105         @echo "To view the help file:"
 106         @echo "# mkdir -p $$HOME/.local/share/devhelp/NativeClient"
 107         @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/NativeClient"
 108         @echo "# devhelp"
 109
 110 epub:
 111         $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
 112         @echo
 113         @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
 114
 115 latex:
 116         $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
 117         @echo
 118         @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
 119         @echo "Run \`make' in that directory to run these through (pdf)latex" \
 120               "(use \`make latexpdf' here to do that automatically)."
 121
 122 latexpdf:
 123         $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
 124         @echo "Running LaTeX files through pdflatex..."
 125         $(MAKE) -C $(BUILDDIR)/latex all-pdf
 126         @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
 127
 128 latexpdfja:
 129         $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
 130         @echo "Running LaTeX files through platex and dvipdfmx..."
 131         $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
 132         @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
 133
 134 text:
 135         $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
 136         @echo
 137         @echo "Build finished. The text files are in $(BUILDDIR)/text."
 138
 139 man:
 140         $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
 141         @echo
 142         @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
 143
 144 texinfo:
 145         $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
 146         @echo
 147         @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
 148         @echo "Run \`make' in that directory to run these through makeinfo" \
 149               "(use \`make info' here to do that automatically)."
 150
 151 info:
 152         $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
 153         @echo "Running Texinfo files through makeinfo..."
 154         make -C $(BUILDDIR)/texinfo info
 155         @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
 156
 157 gettext:
 158         $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
 159         @echo
 160         @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
 161
 162 changes:
 163         $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
 164         @echo
 165         @echo "The overview file is in $(BUILDDIR)/changes."
 166
 167 linkcheck:
 168         $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
 169         @echo
 170         @echo "Link check complete; look for any errors in the above output " \
 171               "or in $(BUILDDIR)/linkcheck/output.txt."
 172
 173 doctest:
 174         $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
 175         @echo "Testing of doctests in the sources finished, look at the " \
 176               "results in $(BUILDDIR)/doctest/output.txt."
 177
 178 xml:
 179         $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
 180         @echo
 181         @echo "Build finished. The XML files are in $(BUILDDIR)/xml."
 182
 183 pseudoxml:
 184         $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
 185         @echo
 186         @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
 187
 188 devsite-prod:
 189         $(SPHINXBUILD) -b devsite -D devsite_production_mode=1 -D devsite_foldername=dev $(ALLSPHINXOPTS) $(BUILDDIR)/devsite-prod
 190         rm -rf $(BUILDDIR)/devsite-prod/images
 191         cp -r $(BUILDDIR)/devsite-prod/_images $(BUILDDIR)/devsite-prod/images
 192         rm -rf $(BUILDDIR)/devsite-prod/{_images,peppercpp,searchindex.js}
 193         @echo
 194         @echo "Build finished. The HTML pages are in $(BUILDDIR)/devsite-prod."
 195
 196 devsite-staging:
 197         $(SPHINXBUILD) -b devsite -D devsite_foldername=$(USER) -D devsite_production_mode=1 $(ALLSPHINXOPTS) $(BUILDDIR)/devsite-staging
 198         rm -rf $(BUILDDIR)/devsite-staging/images
 199         cp -r $(BUILDDIR)/devsite-staging/_images $(BUILDDIR)/devsite-staging/images
 200         cp _reference_toc.yaml $(BUILDDIR)/devsite-staging/
 201         @echo
 202         @echo "Build finished. The HTML pages are in $(BUILDDIR)/devsite-staging."
 203
 204 devsite:
 205         $(SPHINXBUILD) -b devsite -D devsite_production_mode=0 $(ALLSPHINXOPTS) $(BUILDDIR)/devsite
 206         @echo
 207         @echo "Build finished. The HTML pages are in $(BUILDDIR)/devsite."
 208
 209 chromesite:
 210         doxygen/generate_docs.py $(CHROMESITE_BUILDDIR)
 211         $(SPHINXBUILD) -b chromesite $(ALLSPHINXOPTS) $(CHROMESITE_BUILDDIR)
 212         rm -rf $(CHROMESITE_BUILDDIR)/images
 213         cp -r $(CHROMESITE_BUILDDIR)/_images $(CHROMESITE_BUILDDIR)/images
 214         rm -rf $(CHROMESITE_BUILDDIR)/{_images,searchindex.js}
 215         @echo
 216         @echo "Build finished. The HTML pages are in $(CHROMESITE_BUILDDIR)"
 217
 218 chromesite_rst:
 219         $(SPHINXBUILD) -b chromesite $(ALLSPHINXOPTS) $(CHROMESITE_BUILDDIR)
 220         rm -rf $(CHROMESITE_BUILDDIR)/images
 221         cp -r $(CHROMESITE_BUILDDIR)/_images $(CHROMESITE_BUILDDIR)/images
 222         rm -rf $(CHROMESITE_BUILDDIR)/{_images,searchindex.js}
 223
 224
 225 serve:
 226         cd _build/devsite && python -m SimpleHTTPServer 8009
 227
 228 serve_chromesite:
 229         ../../../chrome/common/extensions/docs/server2/preview.py