| Index: native_client_sdk/src/doc/Makefile
|
| diff --git a/native_client_sdk/src/doc/Makefile b/native_client_sdk/src/doc/Makefile
|
| index 0c81812bc266a56fc8989014bc73ed3f803dd9c4..1b9f28b0c8acc6ac1399db11e992c1fdf0448717 100644
|
| --- a/native_client_sdk/src/doc/Makefile
|
| +++ b/native_client_sdk/src/doc/Makefile
|
| @@ -4,7 +4,6 @@
|
| # You can set these variables from the command line.
|
| SPHINXOPTS = -W
|
| SPHINXBUILD = sphinx-build
|
| -PAPER =
|
| BUILDDIR = _build
|
| CHROMESITE_BUILDDIR = $(realpath ../../doc_generated)
|
|
|
| @@ -14,156 +13,24 @@ $(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx in
|
| endif
|
|
|
| # Internal variables.
|
| -PAPEROPT_a4 = -D latex_paper_size=a4
|
| -PAPEROPT_letter = -D latex_paper_size=letter
|
| -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
|
| -# the i18n builder cannot share the environment and doctrees with the others
|
| -I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
|
| +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(SPHINXOPTS) .
|
|
|
| -.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext all
|
| +.PHONY: all help clean linkcheck doctest chromesite chromesite_rst serve
|
|
|
| all: chromesite
|
|
|
| help:
|
| @echo "Please use \`make <target>' where <target> is one of"
|
| - @echo " html to make standalone HTML files"
|
| - @echo " dirhtml to make HTML files named index.html in directories"
|
| - @echo " singlehtml to make a single large HTML file"
|
| - @echo " pickle to make pickle files"
|
| - @echo " json to make JSON files"
|
| - @echo " htmlhelp to make HTML files and a HTML help project"
|
| - @echo " qthelp to make HTML files and a qthelp project"
|
| - @echo " devhelp to make HTML files and a Devhelp project"
|
| - @echo " epub to make an epub"
|
| - @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
|
| - @echo " latexpdf to make LaTeX files and run them through pdflatex"
|
| - @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
|
| - @echo " text to make text files"
|
| - @echo " man to make manual pages"
|
| - @echo " texinfo to make Texinfo files"
|
| - @echo " info to make Texinfo files and run them through makeinfo"
|
| - @echo " gettext to make PO message catalogs"
|
| - @echo " changes to make an overview of all changed/added/deprecated items"
|
| - @echo " xml to make Docutils-native XML files"
|
| - @echo " pseudoxml to make pseudoxml-XML files for display purposes"
|
| - @echo " linkcheck to check all external links for integrity"
|
| - @echo " doctest to run all doctests embedded in the documentation (if enabled)"
|
| - @echo " devsite build locally viewable version of docs for developers.google.com"
|
| - @echo " devsite-prod build production docs for developers.google.com"
|
| - @echo " serve start python web server on port server 8009"
|
| - @echo " chromesite build docs for developer.chrome.com"
|
| - @echo " chromesite_rst only build .rst docs; no doxygen"
|
| - @echo " serve_chromesite start python web server for chromesite docs"
|
| + @echo " chromesite build docs for developer.chrome.com"
|
| + @echo " chromesite_rst only build .rst docs; no doxygen"
|
| + @echo " serve start python web server for chromesite docs"
|
| + @echo " linkcheck to check all external links for integrity"
|
| + @echo " doctest to run all doctests embedded in the documentation (if enabled)"
|
| + @echo " presubmit build docs in a temp directory (for presubmit check)"
|
|
|
| clean:
|
| rm -rf $(BUILDDIR)/*
|
|
|
| -html:
|
| - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
|
| - @echo
|
| - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
|
| -
|
| -dirhtml:
|
| - $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
|
| - @echo
|
| - @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
|
| -
|
| -singlehtml:
|
| - $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
|
| - @echo
|
| - @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
|
| -
|
| -pickle:
|
| - $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
|
| - @echo
|
| - @echo "Build finished; now you can process the pickle files."
|
| -
|
| -json:
|
| - $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
|
| - @echo
|
| - @echo "Build finished; now you can process the JSON files."
|
| -
|
| -htmlhelp:
|
| - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
|
| - @echo
|
| - @echo "Build finished; now you can run HTML Help Workshop with the" \
|
| - ".hhp project file in $(BUILDDIR)/htmlhelp."
|
| -
|
| -qthelp:
|
| - $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
|
| - @echo
|
| - @echo "Build finished; now you can run "qcollectiongenerator" with the" \
|
| - ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
|
| - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/NativeClient.qhcp"
|
| - @echo "To view the help file:"
|
| - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/NativeClient.qhc"
|
| -
|
| -devhelp:
|
| - $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
|
| - @echo
|
| - @echo "Build finished."
|
| - @echo "To view the help file:"
|
| - @echo "# mkdir -p $$HOME/.local/share/devhelp/NativeClient"
|
| - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/NativeClient"
|
| - @echo "# devhelp"
|
| -
|
| -epub:
|
| - $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
|
| - @echo
|
| - @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
|
| -
|
| -latex:
|
| - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
| - @echo
|
| - @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
|
| - @echo "Run \`make' in that directory to run these through (pdf)latex" \
|
| - "(use \`make latexpdf' here to do that automatically)."
|
| -
|
| -latexpdf:
|
| - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
| - @echo "Running LaTeX files through pdflatex..."
|
| - $(MAKE) -C $(BUILDDIR)/latex all-pdf
|
| - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
| -
|
| -latexpdfja:
|
| - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
| - @echo "Running LaTeX files through platex and dvipdfmx..."
|
| - $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
|
| - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
| -
|
| -text:
|
| - $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
|
| - @echo
|
| - @echo "Build finished. The text files are in $(BUILDDIR)/text."
|
| -
|
| -man:
|
| - $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
|
| - @echo
|
| - @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
|
| -
|
| -texinfo:
|
| - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
| - @echo
|
| - @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
|
| - @echo "Run \`make' in that directory to run these through makeinfo" \
|
| - "(use \`make info' here to do that automatically)."
|
| -
|
| -info:
|
| - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
| - @echo "Running Texinfo files through makeinfo..."
|
| - make -C $(BUILDDIR)/texinfo info
|
| - @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
|
| -
|
| -gettext:
|
| - $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
|
| - @echo
|
| - @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
|
| -
|
| -changes:
|
| - $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
|
| - @echo
|
| - @echo "The overview file is in $(BUILDDIR)/changes."
|
| -
|
| linkcheck:
|
| $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
|
| @echo
|
| @@ -175,37 +42,6 @@ doctest:
|
| @echo "Testing of doctests in the sources finished, look at the " \
|
| "results in $(BUILDDIR)/doctest/output.txt."
|
|
|
| -xml:
|
| - $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
|
| - @echo
|
| - @echo "Build finished. The XML files are in $(BUILDDIR)/xml."
|
| -
|
| -pseudoxml:
|
| - $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
|
| - @echo
|
| - @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
|
| -
|
| -devsite-prod:
|
| - $(SPHINXBUILD) -b devsite -D devsite_production_mode=1 -D devsite_foldername=dev $(ALLSPHINXOPTS) $(BUILDDIR)/devsite-prod
|
| - rm -rf $(BUILDDIR)/devsite-prod/images
|
| - cp -r $(BUILDDIR)/devsite-prod/_images $(BUILDDIR)/devsite-prod/images
|
| - rm -rf $(BUILDDIR)/devsite-prod/{_images,peppercpp,searchindex.js}
|
| - @echo
|
| - @echo "Build finished. The HTML pages are in $(BUILDDIR)/devsite-prod."
|
| -
|
| -devsite-staging:
|
| - $(SPHINXBUILD) -b devsite -D devsite_foldername=$(USER) -D devsite_production_mode=1 $(ALLSPHINXOPTS) $(BUILDDIR)/devsite-staging
|
| - rm -rf $(BUILDDIR)/devsite-staging/images
|
| - cp -r $(BUILDDIR)/devsite-staging/_images $(BUILDDIR)/devsite-staging/images
|
| - cp _reference_toc.yaml $(BUILDDIR)/devsite-staging/
|
| - @echo
|
| - @echo "Build finished. The HTML pages are in $(BUILDDIR)/devsite-staging."
|
| -
|
| -devsite:
|
| - $(SPHINXBUILD) -b devsite -D devsite_production_mode=0 $(ALLSPHINXOPTS) $(BUILDDIR)/devsite
|
| - @echo
|
| - @echo "Build finished. The HTML pages are in $(BUILDDIR)/devsite."
|
| -
|
| chromesite:
|
| -rm $(CHROMESITE_BUILDDIR)/.buildinfo
|
| doxygen/generate_docs.py $(CHROMESITE_BUILDDIR)
|
| @@ -217,14 +53,15 @@ chromesite:
|
| @echo "Build finished. The HTML pages are in $(CHROMESITE_BUILDDIR)"
|
|
|
| chromesite_rst:
|
| + -rm $(CHROMESITE_BUILDDIR)/.buildinfo
|
| $(SPHINXBUILD) -b chromesite $(ALLSPHINXOPTS) $(CHROMESITE_BUILDDIR)
|
| rm -rf $(CHROMESITE_BUILDDIR)/images
|
| cp -r $(CHROMESITE_BUILDDIR)/_images $(CHROMESITE_BUILDDIR)/images
|
| rm -rf $(CHROMESITE_BUILDDIR)/{_images,searchindex.js}
|
|
|
| +presubmit:
|
| + -rm $(BUILDDIR)/.buildinfo
|
| + $(SPHINXBUILD) -b chromesite $(ALLSPHINXOPTS) $(BUILDDIR)
|
|
|
| serve:
|
| - cd _build/devsite && python -m SimpleHTTPServer 8009
|
| -
|
| -serve_chromesite:
|
| ../../../chrome/common/extensions/docs/server2/preview.py
|
|
|