docs/Makefile.sphinx - Issue 1571883002: initial sphinx doc production patch for subzero

Side by Side Diff: docs/Makefile.sphinx

Issue 1571883002: initial sphinx doc production patch for subzero (Closed) Base URL: https://chromium.googlesource.com/native_client/pnacl-subzero.git@master

Patch Set: Created 4 years, 11 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

OLD	NEW
(Empty)
	1 # Makefile for Sphinx documentation
	Jim Stichnoth 2016/01/20 19:00:36 Make document that this file originated from some Make document that this file originated from some particular LLVM file? rkotlerimgtec 2016/01/20 22:50:42 Done. Show quoted text On 2016/01/20 19:00:36, stichnot wrote: > Make document that this file originated from some particular LLVM file? Done.
	2 #

	3

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

	5 SPHINXOPTS =

	6 SPHINXBUILD = mkdir -p $(BUILDDIR) && sphinx-build
	Jim Stichnoth 2016/01/20 19:00:37 I would document somewhere (maybe at the very top) I would document somewhere (maybe at the very top) that the sphinx-build package is required, e.g. apt-get install python-sphinx rkotlerimgtec 2016/01/20 22:50:42 Comment put in. comes preinstalled on Ubuntu. We j Show quoted text On 2016/01/20 19:00:37, stichnot wrote: > I would document somewhere (maybe at the very top) that the sphinx-build package > is required, e.g. > apt-get install python-sphinx Comment put in. comes preinstalled on Ubuntu. We just need sphinx-build.
	7 PAPER =

	8 BUILDDIR = ../build/sphinx

	9

	10 # Internal variables.

	11 PAPEROPT_a4 = -D latex_paper_size=a4

	12 PAPEROPT_letter = -D latex_paper_size=letter

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

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

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

	16

	17 .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp e pub latex latexpdf text man changes linkcheck doctest gettext
	Jim Stichnoth 2016/01/20 19:00:37 There are a bunch of 80-col issues in this file, t There are a bunch of 80-col issues in this file, thanks most likely to tab characters. rkotlerimgtec 2016/01/20 22:50:42 Done. Show quoted text On 2016/01/20 19:00:37, stichnot wrote: > There are a bunch of 80-col issues in this file, thanks most likely to tab > characters. Done.
	18

	19 all: html

	20

	21 help:

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

	23 @echo " html to make standalone HTML files"

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

	25 @echo " singlehtml to make a single large HTML file"

	26 @echo " pickle to make pickle files"

	27 @echo " json to make JSON files"

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

	29 @echo " qthelp to make HTML files and a qthelp project"

	30 @echo " devhelp to make HTML files and a Devhelp project"

	31 @echo " epub to make an epub"

	32 @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=l etter"

	33 @echo " latexpdf to make LaTeX files and run them through pdflatex"

	34 @echo " text to make text files"

	35 @echo " man to make manual pages"

	36 @echo " texinfo to make Texinfo files"

	37 @echo " info to make Texinfo files and run them through makeinfo"

	38 @echo " gettext to make PO message catalogs"

	39 @echo " changes to make an overview of all changed/added/deprecated items"

	40 @echo " linkcheck to check all external links for integrity"

	41 @echo " doctest to run all doctests embedded in the documentation (i f enabled)"

	42

	43 clean:

	44 -rm -rf $(BUILDDIR)/*

	45

	46 html:

	47 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html

	48 @echo

	49 @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."

	50

	51 dirhtml:

	52 $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml

	53 @echo

	54 @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."

	55

	56 singlehtml:

	57 $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml

	58 @echo

	59 @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."

	60

	61 pickle:

	62 $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle

	63 @echo

	64 @echo "Build finished; now you can process the pickle files."

	65

	66 json:

	67 $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json

	68 @echo

	69 @echo "Build finished; now you can process the JSON files."

	70

	71 htmlhelp:

	72 $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp

	73 @echo

	74 @echo "Build finished; now you can run HTML Help Workshop with the" \
	Jim Stichnoth 2016/01/20 19:00:37 I think it might be better to @echo multiple lines I think it might be better to @echo multiple lines instead of using the \ continuation. rkotlerimgtec 2016/01/20 22:50:42 Done. Show quoted text On 2016/01/20 19:00:37, stichnot wrote: > I think it might be better to @echo multiple lines instead of using the \ > continuation. Done.
	75 ".hhp project file in $(BUILDDIR)/htmlhelp."

	76

	77 qthelp:

	78 $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp

	79 @echo

	80 @echo "Build finished; now you can run "qcollectiongenerator" with the" \
	Jim Stichnoth 2016/01/20 19:00:37 Quotes inside quotes probably aren't doing what yo Quotes inside quotes probably aren't doing what you expect... You probably want something similar to what the "latex" target does. rkotlerimgtec 2016/01/20 22:50:42 Done. Show quoted text On 2016/01/20 19:00:37, stichnot wrote: > Quotes inside quotes probably aren't doing what you expect... You probably want > something similar to what the "latex" target does. Done.
	81 ".qhcp project file in $(BUILDDIR)/qthelp, like this:"

	82 @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/llvm.qhcp"

	83 @echo "To view the help file:"

	84 @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/llvm.qhc"

	85

	86 devhelp:

	87 $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp

	88 @echo

	89 @echo "Build finished."

	90 @echo "To view the help file:"

	91 @echo "# mkdir -p $$HOME/.local/share/devhelp/llvm"

	92 @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/llvm"

	93 @echo "# devhelp"

	94

	95 epub:

	96 $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub

	97 @echo

	98 @echo "Build finished. The epub file is in $(BUILDDIR)/epub."

	99

	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

	107 latexpdf:

	108 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex

	109 @echo "Running LaTeX files through pdflatex..."

	110 $(MAKE) -C $(BUILDDIR)/latex all-pdf

	111 @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."

	112

	113 text:

	114 $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text

	115 @echo

	116 @echo "Build finished. The text files are in $(BUILDDIR)/text."

	117

	118 man:

	119 $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man

	120 @echo

	121 @echo "Build finished. The manual pages are in $(BUILDDIR)/man."

	122

	123 texinfo:

	124 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo

	125 @echo

	126 @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."

	127 @echo "Run \`make' in that directory to run these through makeinfo" \

	128 "(use \`make info' here to do that automatically)."

	129

	130 info:

	131 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo

	132 @echo "Running Texinfo files through makeinfo..."

	133 make -C $(BUILDDIR)/texinfo info

	134 @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."

	135

	136 gettext:

	137 $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale

	138 @echo

	139 @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."

	140

	141 changes:

	142 $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes

	143 @echo

	144 @echo "The overview file is in $(BUILDDIR)/changes."

	145

	146 linkcheck:

	147 $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck

	148 @echo

	149 @echo "Link check complete; look for any errors in the above output " \
	Jim Stichnoth 2016/01/20 19:00:36 My OCD points out that some of these continued str My OCD points out that some of these continued strings have a trailing space before the end quote, and some don't. Note that if you expand it out, something like: @echo "abc" "def" will print: abc def so you probably don't want the trailing space. rkotlerimgtec 2016/01/20 22:50:42 Done. Show quoted text On 2016/01/20 19:00:36, stichnot wrote: > My OCD points out that some of these continued strings have a trailing space > before the end quote, and some don't. Note that if you expand it out, something > like: > @echo "abc" "def" > will print: > abc def > so you probably don't want the trailing space. Done.
	150 "or in $(BUILDDIR)/linkcheck/output.txt."

	151

	152 doctest:

	153 $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest

	154 @echo "Testing of doctests in the sources finished, look at the " \

	155 "results in $(BUILDDIR)/doctest/output.txt."

OLD	NEW

« no previous file with comments | « no previous file | docs/conf.py » ('j') | no next file with comments »