From c8b363e547635e92a78c5718e9f17a5e8f55dc7f Mon Sep 17 00:00:00 2001 From: michr Date: Thu, 29 Sep 2011 02:03:33 -0700 Subject: avoid warning for latexindex, foreword by putting them in a hidden toc from now on complie docs strictly, turning warnings to errors exclude unnecssary static js files when compiling ePub --- docs/Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/Makefile') diff --git a/docs/Makefile b/docs/Makefile index 1d032cf45..92dc56fda 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -2,7 +2,7 @@ # # You can set these variables from the command line. -SPHINXOPTS = +SPHINXOPTS = -W SPHINXBUILD = sphinx-build PAPER = -- cgit v1.2.3 From cc4e916e4e79fb85e36d108c6a569215bbd32174 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Mon, 17 Oct 2011 21:40:52 -0400 Subject: use a git submodule for themes --- docs/Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/Makefile') diff --git a/docs/Makefile b/docs/Makefile index 92dc56fda..d3a83facc 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -85,4 +85,4 @@ epub: @echo "Build finished. The epub file is in _build/epub." _themes: - git clone git://github.com/Pylons/pylons_sphinx_theme.git _themes + cd ..; git submodule update --init; cd docs -- cgit v1.2.3 From afbb22395b3bf22028b231b4b96dea512869097c Mon Sep 17 00:00:00 2001 From: Michael Merickel Date: Mon, 24 Oct 2011 19:09:25 -0500 Subject: Added _themes to the clean target to reclone the submodule. --- docs/Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/Makefile') diff --git a/docs/Makefile b/docs/Makefile index d3a83facc..373d549af 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -23,7 +23,7 @@ help: @echo " linkcheck to check all external links for integrity" clean: - -rm -rf _build/* + -rm -rf _build/* _themes html: _themes mkdir -p _build/html _build/doctrees -- cgit v1.2.3 From d0a25788fca2d2ebbf008658401e0d64ae232a8d Mon Sep 17 00:00:00 2001 From: Blaise Laflamme Date: Sun, 27 Nov 2011 12:33:27 -0500 Subject: updated doc theme workflow --- docs/Makefile | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) (limited to 'docs/Makefile') diff --git a/docs/Makefile b/docs/Makefile index 373d549af..bb381fc53 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -23,9 +23,9 @@ help: @echo " linkcheck to check all external links for integrity" clean: - -rm -rf _build/* _themes + -rm -rf _build/* -html: _themes +html: mkdir -p _build/html _build/doctrees $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html @echo @@ -47,7 +47,7 @@ pickle: web: pickle -htmlhelp: _themes +htmlhelp: mkdir -p _build/htmlhelp _build/doctrees $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) _build/htmlhelp @echo @@ -84,5 +84,3 @@ epub: @echo @echo "Build finished. The epub file is in _build/epub." -_themes: - cd ..; git submodule update --init; cd docs -- cgit v1.2.3 From eba3b0763cf4fa3aa4b099adb2e10c53c6d99e74 Mon Sep 17 00:00:00 2001 From: Blaise Laflamme Date: Sun, 6 May 2012 19:56:21 -0400 Subject: added sphinx theme as submodule, added rtd hack to update theme --- docs/Makefile | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) (limited to 'docs/Makefile') diff --git a/docs/Makefile b/docs/Makefile index bb381fc53..e4a325022 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -25,7 +25,7 @@ help: clean: -rm -rf _build/* -html: +html: _themes mkdir -p _build/html _build/doctrees $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html @echo @@ -47,7 +47,7 @@ pickle: web: pickle -htmlhelp: +htmlhelp: _themes mkdir -p _build/htmlhelp _build/doctrees $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) _build/htmlhelp @echo @@ -84,3 +84,5 @@ epub: @echo @echo "Build finished. The epub file is in _build/epub." +_themes: + git submodule update --init -- cgit v1.2.3 From 6f5401a470f51c372eb6f996592487fdd2a4bb03 Mon Sep 17 00:00:00 2001 From: Blaise Laflamme Date: Sun, 16 Sep 2012 00:24:20 -0300 Subject: fixed git submodule update for docs --- docs/Makefile | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'docs/Makefile') diff --git a/docs/Makefile b/docs/Makefile index e4a325022..a66f93d60 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -25,7 +25,7 @@ help: clean: -rm -rf _build/* -html: _themes +html: themes mkdir -p _build/html _build/doctrees $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html @echo @@ -47,7 +47,7 @@ pickle: web: pickle -htmlhelp: _themes +htmlhelp: themes mkdir -p _build/htmlhelp _build/doctrees $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) _build/htmlhelp @echo @@ -85,4 +85,4 @@ epub: @echo "Build finished. The epub file is in _build/epub." _themes: - git submodule update --init + cd ..; git submodule update --init --recursive; cd docs; -- cgit v1.2.3 From a9e278e5e0cb4f5fb290c296bed55eee510d0d37 Mon Sep 17 00:00:00 2001 From: Blaise Laflamme Date: Sun, 16 Sep 2012 00:37:26 -0300 Subject: fixed typo --- docs/Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/Makefile') diff --git a/docs/Makefile b/docs/Makefile index a66f93d60..c98fdc65e 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -84,5 +84,5 @@ epub: @echo @echo "Build finished. The epub file is in _build/epub." -_themes: +themes: cd ..; git submodule update --init --recursive; cd docs; -- cgit v1.2.3 From 239485e0722a580115173833b432d85c44c3a34c Mon Sep 17 00:00:00 2001 From: Tshepang Lekhonkhobe Date: Sun, 28 Jul 2013 17:45:03 +0200 Subject: [docs] add latexpdf target I looked at latest Sphinx sources (in sphinx/quickstart.py) on how this is done --- docs/Makefile | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) (limited to 'docs/Makefile') diff --git a/docs/Makefile b/docs/Makefile index c98fdc65e..12dc88bf8 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -63,8 +63,13 @@ latex: cp _static/latex-note.png _build/latex @echo @echo "Build finished; the LaTeX files are in _build/latex." - @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \ - "run these through (pdf)latex." + @echo "Run \`make latexpdf' to build a PDF file from them." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C _build/latex all-pdf + @echo "pdflatex finished; the PDF file is in _build/latex." changes: mkdir -p _build/changes _build/doctrees -- cgit v1.2.3 From cc443a4678298188d4b0a178540118ef3b123291 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Thu, 16 Apr 2015 17:25:23 -0400 Subject: - update sphinx makefile - git submodule deinit . - replace git submodule with new pylons-sphinx-themes package. See #1614, #1596 --- docs/Makefile | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) (limited to 'docs/Makefile') diff --git a/docs/Makefile b/docs/Makefile index 12dc88bf8..2f83fbe06 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -25,7 +25,7 @@ help: clean: -rm -rf _build/* -html: themes +html: mkdir -p _build/html _build/doctrees $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html @echo @@ -47,7 +47,7 @@ pickle: web: pickle -htmlhelp: themes +htmlhelp: mkdir -p _build/htmlhelp _build/doctrees $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) _build/htmlhelp @echo @@ -89,5 +89,3 @@ epub: @echo @echo "Build finished. The epub file is in _build/epub." -themes: - cd ..; git submodule update --init --recursive; cd docs; -- cgit v1.2.3 From 4d8580c92b1c4ed45e954f79fcbe1dc018ee700b Mon Sep 17 00:00:00 2001 From: Michael Merickel Date: Sun, 19 Apr 2015 16:14:17 -0500 Subject: add epub to docs and specify a env-specific build dir for docs --- docs/Makefile | 63 ++++++++++++++++++++++++++++++----------------------------- 1 file changed, 32 insertions(+), 31 deletions(-) (limited to 'docs/Makefile') diff --git a/docs/Makefile b/docs/Makefile index 2f83fbe06..546deb30a 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -5,11 +5,12 @@ SPHINXOPTS = -W SPHINXBUILD = sphinx-build PAPER = +BUILDDIR = _build # Internal variables. PAPEROPT_a4 = -D latex_paper_size=a4 PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d _build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . .PHONY: help clean html web pickle htmlhelp latex changes linkcheck @@ -23,69 +24,69 @@ help: @echo " linkcheck to check all external links for integrity" clean: - -rm -rf _build/* + -rm -rf $(BUILDDIR)/* html: - mkdir -p _build/html _build/doctrees - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html + mkdir -p $(BUILDDIR)/html $(BUILDDIR)/doctrees + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html @echo - @echo "Build finished. The HTML pages are in _build/html." + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." text: - mkdir -p _build/text _build/doctrees - $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) _build/text + mkdir -p $(BUILDDIR)/text $(BUILDDIR)/doctrees + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text @echo - @echo "Build finished. The HTML pages are in _build/text." + @echo "Build finished. The HTML pages are in $(BUILDDIR)/text." pickle: - mkdir -p _build/pickle _build/doctrees - $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) _build/pickle + mkdir -p $(BUILDDIR)/pickle $(BUILDDIR)/doctrees + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle @echo @echo "Build finished; now you can process the pickle files or run" - @echo " sphinx-web _build/pickle" + @echo " sphinx-web $(BUILDDIR)/pickle" @echo "to start the sphinx-web server." web: pickle htmlhelp: - mkdir -p _build/htmlhelp _build/doctrees - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) _build/htmlhelp + mkdir -p $(BUILDDIR)/htmlhelp $(BUILDDIR)/doctrees + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp @echo @echo "Build finished; now you can run HTML Help Workshop with the" \ - ".hhp project file in _build/htmlhelp." + ".hhp project file in $(BUILDDIR)/htmlhelp." latex: - mkdir -p _build/latex _build/doctrees - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex - cp _static/*.png _build/latex + mkdir -p $(BUILDDIR)/latex $(BUILDDIR)/doctrees + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + cp _static/*.png $(BUILDDIR)/latex ./convert_images.sh - cp _static/latex-warning.png _build/latex - cp _static/latex-note.png _build/latex + cp _static/latex-warning.png $(BUILDDIR)/latex + cp _static/latex-note.png $(BUILDDIR)/latex @echo - @echo "Build finished; the LaTeX files are in _build/latex." + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." @echo "Run \`make latexpdf' to build a PDF file from them." latexpdf: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo "Running LaTeX files through pdflatex..." - $(MAKE) -C _build/latex all-pdf - @echo "pdflatex finished; the PDF file is in _build/latex." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF file is in $(BUILDDIR)/latex." changes: - mkdir -p _build/changes _build/doctrees - $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) _build/changes + mkdir -p $(BUILDDIR)/changes $(BUILDDIR)/doctrees + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes @echo - @echo "The overview file is in _build/changes." + @echo "The overview file is in $(BUILDDIR)/changes." linkcheck: - mkdir -p _build/linkcheck _build/doctrees - $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) _build/linkcheck + mkdir -p $(BUILDDIR)/linkcheck $(BUILDDIR)/doctrees + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck @echo @echo "Link check complete; look for any errors in the above output " \ - "or in _build/linkcheck/output.txt." + "or in $(BUILDDIR)/linkcheck/output.txt." epub: - $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) _build/epub + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub @echo - @echo "Build finished. The epub file is in _build/epub." + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." -- cgit v1.2.3