native_client_sdk/src/doc/Makefile - Issue 23531031: Minor cleanups for SDK devsite docs.

Side by Side Diff: native_client_sdk/src/doc/Makefile

Issue 23531031: Minor cleanups for SDK devsite docs. (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src

Patch Set: Created 7 years, 3 months ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

View unified diff | Download patch | Annotate | Revision Log

OLD	NEW
1 # Makefile for Sphinx documentation	1 # Makefile for Sphinx documentation

2 #	2 #

3	3

4 # You can set these variables from the command line.	4 # You can set these variables from the command line.

5 SPHINXOPTS =	5 SPHINXOPTS = -W

6 SPHINXBUILD = sphinx-build	6 SPHINXBUILD = sphinx-build

7 PAPER =	7 PAPER =

8 BUILDDIR = _build	8 BUILDDIR = out
	eliben 2013/09/04 21:50:51 Why out and not _build? _build is standard for Sph Why out and not _build? _build is standard for Sphinx and it starts with an underscore so it's unlikely to clash with real subdirs Sam Clegg 2013/09/04 21:54:30 Just because 'out' is the convention for chrome an Show quoted text On 2013/09/04 21:50:51, eliben wrote: > Why out and not _build? _build is standard for Sphinx and it starts with an > underscore so it's unlikely to clash with real subdirs Just because 'out' is the convention for chrome and native_client. I don't care too much about this. eliben 2013/09/05 15:47:21 I don't care too much either. I stated the reasons Show quoted text On 2013/09/04 21:54:30, Sam Clegg wrote: > On 2013/09/04 21:50:51, eliben wrote: > > Why out and not _build? _build is standard for Sphinx and it starts with an > > underscore so it's unlikely to clash with real subdirs > > Just because 'out' is the convention for chrome and native_client. > > I don't care too much about this. > I don't care too much either. I stated the reasons for keeping _build; you decide ;-)
9	9

10 # User-friendly check for sphinx-build	10 # User-friendly check for sphinx-build

11 ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)	11 ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)

12 $(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx in stalled, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory wit h the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)	12 $(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx in stalled, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory wit h the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)

13 endif	13 endif

14	14

15 # Internal variables.	15 # Internal variables.

16 PAPEROPT_a4 = -D latex_paper_size=a4	16 PAPEROPT_a4 = -D latex_paper_size=a4

17 PAPEROPT_letter = -D latex_paper_size=letter	17 PAPEROPT_letter = -D latex_paper_size=letter

18 ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .	18 ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .

19 # the i18n builder cannot share the environment and doctrees with the others	19 # the i18n builder cannot share the environment and doctrees with the others

20 I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .	20 I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .

21	21

22 .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp e pub latex latexpdf text man changes linkcheck doctest gettext	22 .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp e pub latex latexpdf text man changes linkcheck doctest gettext all

	23

	24 all: devsite

23	25

24 help:	26 help:

25 @echo "Please use \`make <target>' where <target> is one of"	27 @echo "Please use \`make <target>' where <target> is one of"

26 @echo " html to make standalone HTML files"	28 @echo " html to make standalone HTML files"

27 @echo " dirhtml to make HTML files named index.html in directories"	29 @echo " dirhtml to make HTML files named index.html in directories"

28 @echo " singlehtml to make a single large HTML file"	30 @echo " singlehtml to make a single large HTML file"

29 @echo " pickle to make pickle files"	31 @echo " pickle to make pickle files"

30 @echo " json to make JSON files"	32 @echo " json to make JSON files"

31 @echo " htmlhelp to make HTML files and a HTML help project"	33 @echo " htmlhelp to make HTML files and a HTML help project"

32 @echo " qthelp to make HTML files and a qthelp project"	34 @echo " qthelp to make HTML files and a qthelp project"

(...skipping 142 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
175	177

176 pseudoxml:	178 pseudoxml:

177 $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml	179 $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml

178 @echo	180 @echo

179 @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml ."	181 @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml ."

180	182

181 devsite:	183 devsite:

182 $(SPHINXBUILD) -b devsite $(ALLSPHINXOPTS) $(BUILDDIR)/devsite	184 $(SPHINXBUILD) -b devsite $(ALLSPHINXOPTS) $(BUILDDIR)/devsite

183	185

184 serve:	186 serve:

185 » cd _build/devsite && python -m SimpleHTTPServer 8009	187 » cd out/devsite && python -m SimpleHTTPServer 8009

OLD	NEW

« no previous file with comments | « native_client_sdk/src/doc/.gitignore ('k') | native_client_sdk/src/doc/README » ('j') | native_client_sdk/src/doc/devguide/devcycle/debugging.rst » ('J')