IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

#252: Make it easier to change the build dir in the Makefiles

Browse Source 
generated by quickstart.
This commit is contained in:
Georg Brandl 2009-09-03 17:53:47 +02:00
parent a392b15c12
commit 3276bb42c8
2 changed files with 50 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
CHANGES
View File

@ -1,6 +1,9 @@
Release 0.6.3 (in development) Release 0.6.3 (in development)
============================== ==============================
* #252: Make it easier to change the build dir in the Makefiles
generated by quickstart.
* #220: Fix CSS so that displaymath really is centered. * #220: Fix CSS so that displaymath really is centered.
* #222: Allow the "Footnotes" header to be translated. * #222: Allow the "Footnotes" header to be translated.

92
sphinx/quickstart.py
View File

@ -256,11 +256,12 @@ MAKEFILE = '''\
SPHINXOPTS = SPHINXOPTS =
SPHINXBUILD = sphinx-build SPHINXBUILD = sphinx-build
PAPER = PAPER =
BUILDDIR = %(rbuilddir)s
# Internal variables. # Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4 PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d %(rbuilddir)s/doctrees $(PAPEROPT_$(PAPER)) \ ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) \
$(SPHINXOPTS) %(rsrcdir)s $(SPHINXOPTS) %(rsrcdir)s
.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes \ .PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes \
@ -281,65 +282,65 @@ help:
(if enabled)" (if enabled)"
clean: clean:
\t-rm -rf %(rbuilddir)s/* \t-rm -rf $(BUILDDIR)/*
html: html:
\t$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) %(rbuilddir)s/html \t$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
\t@echo \t@echo
\t@echo "Build finished. The HTML pages are in %(rbuilddir)s/html." \t@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
dirhtml: dirhtml:
\t$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) %(rbuilddir)s/dirhtml \t$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
\t@echo \t@echo
\t@echo "Build finished. The HTML pages are in %(rbuilddir)s/dirhtml." \t@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
pickle: pickle:
\t$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) %(rbuilddir)s/pickle \t$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
\t@echo \t@echo
\t@echo "Build finished; now you can process the pickle files." \t@echo "Build finished; now you can process the pickle files."
json: json:
\t$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) %(rbuilddir)s/json \t$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
\t@echo \t@echo
\t@echo "Build finished; now you can process the JSON files." \t@echo "Build finished; now you can process the JSON files."
htmlhelp: htmlhelp:
\t$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) %(rbuilddir)s/htmlhelp \t$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
\t@echo \t@echo
\t@echo "Build finished; now you can run HTML Help Workshop with the" \\ \t@echo "Build finished; now you can run HTML Help Workshop with the" \\
\t ".hhp project file in %(rbuilddir)s/htmlhelp." \t ".hhp project file in $(BUILDDIR)/htmlhelp."
qthelp: qthelp:
\t$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) %(rbuilddir)s/qthelp \t$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
\t@echo \t@echo
\t@echo "Build finished; now you can run "qcollectiongenerator" with the" \\ \t@echo "Build finished; now you can run "qcollectiongenerator" with the" \\
\t ".qhcp project file in %(rbuilddir)s/qthelp, like this:" \t ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
\t@echo "# qcollectiongenerator %(rbuilddir)s/qthelp/%(project_fn)s.qhcp" \t@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/%(project_fn)s.qhcp"
\t@echo "To view the help file:" \t@echo "To view the help file:"
\t@echo "# assistant -collectionFile %(rbuilddir)s/qthelp/%(project_fn)s.qhc" \t@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/%(project_fn)s.qhc"
latex: latex:
\t$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) %(rbuilddir)s/latex \t$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
\t@echo \t@echo
\t@echo "Build finished; the LaTeX files are in %(rbuilddir)s/latex." \t@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
\t@echo "Run \\`make all-pdf' or \\`make all-ps' in that directory to" \\ \t@echo "Run \\`make all-pdf' or \\`make all-ps' in that directory to" \\
\t "run these through (pdf)latex." \t "run these through (pdf)latex."
changes: changes:
\t$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) %(rbuilddir)s/changes \t$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
\t@echo \t@echo
\t@echo "The overview file is in %(rbuilddir)s/changes." \t@echo "The overview file is in $(BUILDDIR)/changes."
linkcheck: linkcheck:
\t$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) %(rbuilddir)s/linkcheck \t$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
\t@echo \t@echo
\t@echo "Link check complete; look for any errors in the above output " \\ \t@echo "Link check complete; look for any errors in the above output " \\
\t "or in %(rbuilddir)s/linkcheck/output.txt." \t "or in $(BUILDDIR)/linkcheck/output.txt."
doctest: doctest:
\t$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) %(rbuilddir)s/doctest \t$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
\t@echo "Testing of doctests in the sources finished, look at the " \\ \t@echo "Testing of doctests in the sources finished, look at the " \\
\t "results in %(rbuilddir)s/doctest/output.txt." \t "results in $(BUILDDIR)/doctest/output.txt."
''' '''
BATCHFILE = '''\ BATCHFILE = '''\
@ -348,7 +349,8 @@ BATCHFILE = '''\
REM Command file for Sphinx documentation REM Command file for Sphinx documentation
set SPHINXBUILD=sphinx-build set SPHINXBUILD=sphinx-build
set ALLSPHINXOPTS=-d %(rbuilddir)s/doctrees %%SPHINXOPTS%% %(rsrcdir)s set BUILDDIR=%(rbuilddir)s
set ALLSPHINXOPTS=-d %%BUILDDIR%%/doctrees %%SPHINXOPTS%% %(rsrcdir)s
if NOT "%%PAPER%%" == "" ( if NOT "%%PAPER%%" == "" (
\tset ALLSPHINXOPTS=-D latex_paper_size=%%PAPER%% %%ALLSPHINXOPTS%% \tset ALLSPHINXOPTS=-D latex_paper_size=%%PAPER%% %%ALLSPHINXOPTS%%
) )
@ -372,85 +374,85 @@ if "%%1" == "help" (
) )
if "%%1" == "clean" ( if "%%1" == "clean" (
\tfor /d %%%%i in (%(rbuilddir)s\*) do rmdir /q /s %%%%i \tfor /d %%%%i in (%%BUILDDIR%%\*) do rmdir /q /s %%%%i
\tdel /q /s %(rbuilddir)s\* \tdel /q /s %%BUILDDIR%%\*
\tgoto end \tgoto end
) )
if "%%1" == "html" ( if "%%1" == "html" (
\t%%SPHINXBUILD%% -b html %%ALLSPHINXOPTS%% %(rbuilddir)s/html \t%%SPHINXBUILD%% -b html %%ALLSPHINXOPTS%% %%BUILDDIR%%/html
\techo. \techo.
\techo.Build finished. The HTML pages are in %(rbuilddir)s/html. \techo.Build finished. The HTML pages are in %%BUILDDIR%%/html.
\tgoto end \tgoto end
) )
if "%%1" == "dirhtml" ( if "%%1" == "dirhtml" (
\t%%SPHINXBUILD%% -b dirhtml %%ALLSPHINXOPTS%% %(rbuilddir)s/dirhtml \t%%SPHINXBUILD%% -b dirhtml %%ALLSPHINXOPTS%% %%BUILDDIR%%/dirhtml
\techo. \techo.
\techo.Build finished. The HTML pages are in %(rbuilddir)s/dirhtml. \techo.Build finished. The HTML pages are in %%BUILDDIR%%/dirhtml.
\tgoto end \tgoto end
) )
if "%%1" == "pickle" ( if "%%1" == "pickle" (
\t%%SPHINXBUILD%% -b pickle %%ALLSPHINXOPTS%% %(rbuilddir)s/pickle \t%%SPHINXBUILD%% -b pickle %%ALLSPHINXOPTS%% %%BUILDDIR%%/pickle
\techo. \techo.
\techo.Build finished; now you can process the pickle files. \techo.Build finished; now you can process the pickle files.
\tgoto end \tgoto end
) )
if "%%1" == "json" ( if "%%1" == "json" (
\t%%SPHINXBUILD%% -b json %%ALLSPHINXOPTS%% %(rbuilddir)s/json \t%%SPHINXBUILD%% -b json %%ALLSPHINXOPTS%% %%BUILDDIR%%/json
\techo. \techo.
\techo.Build finished; now you can process the JSON files. \techo.Build finished; now you can process the JSON files.
\tgoto end \tgoto end
) )
if "%%1" == "htmlhelp" ( if "%%1" == "htmlhelp" (
\t%%SPHINXBUILD%% -b htmlhelp %%ALLSPHINXOPTS%% %(rbuilddir)s/htmlhelp \t%%SPHINXBUILD%% -b htmlhelp %%ALLSPHINXOPTS%% %%BUILDDIR%%/htmlhelp
\techo. \techo.
\techo.Build finished; now you can run HTML Help Workshop with the ^ \techo.Build finished; now you can run HTML Help Workshop with the ^
.hhp project file in %(rbuilddir)s/htmlhelp. .hhp project file in %%BUILDDIR%%/htmlhelp.
\tgoto end \tgoto end
) )
if "%%1" == "qthelp" ( if "%%1" == "qthelp" (
\t%%SPHINXBUILD%% -b qthelp %%ALLSPHINXOPTS%% %(rbuilddir)s/qthelp \t%%SPHINXBUILD%% -b qthelp %%ALLSPHINXOPTS%% %%BUILDDIR%%/qthelp
\techo. \techo.
\techo.Build finished; now you can run "qcollectiongenerator" with the ^ \techo.Build finished; now you can run "qcollectiongenerator" with the ^
.qhcp project file in %(rbuilddir)s/qthelp, like this: .qhcp project file in %%BUILDDIR%%/qthelp, like this:
\techo.^> qcollectiongenerator %(rbuilddir)s\\qthelp\\%(project_fn)s.qhcp \techo.^> qcollectiongenerator %%BUILDDIR%%\\qthelp\\%(project_fn)s.qhcp
\techo.To view the help file: \techo.To view the help file:
\techo.^> assistant -collectionFile %(rbuilddir)s\\qthelp\\%(project_fn)s.ghc \techo.^> assistant -collectionFile %%BUILDDIR%%\\qthelp\\%(project_fn)s.ghc
\tgoto end \tgoto end
) )
if "%%1" == "latex" ( if "%%1" == "latex" (
\t%%SPHINXBUILD%% -b latex %%ALLSPHINXOPTS%% %(rbuilddir)s/latex \t%%SPHINXBUILD%% -b latex %%ALLSPHINXOPTS%% %%BUILDDIR%%/latex
\techo. \techo.
\techo.Build finished; the LaTeX files are in %(rbuilddir)s/latex. \techo.Build finished; the LaTeX files are in %%BUILDDIR%%/latex.
\tgoto end \tgoto end
) )
if "%%1" == "changes" ( if "%%1" == "changes" (
\t%%SPHINXBUILD%% -b changes %%ALLSPHINXOPTS%% %(rbuilddir)s/changes \t%%SPHINXBUILD%% -b changes %%ALLSPHINXOPTS%% %%BUILDDIR%%/changes
\techo. \techo.
\techo.The overview file is in %(rbuilddir)s/changes. \techo.The overview file is in %%BUILDDIR%%/changes.
\tgoto end \tgoto end
) )
if "%%1" == "linkcheck" ( if "%%1" == "linkcheck" (
\t%%SPHINXBUILD%% -b linkcheck %%ALLSPHINXOPTS%% %(rbuilddir)s/linkcheck \t%%SPHINXBUILD%% -b linkcheck %%ALLSPHINXOPTS%% %%BUILDDIR%%/linkcheck
\techo. \techo.
\techo.Link check complete; look for any errors in the above output ^ \techo.Link check complete; look for any errors in the above output ^
or in %(rbuilddir)s/linkcheck/output.txt. or in %%BUILDDIR%%/linkcheck/output.txt.
\tgoto end \tgoto end
) )
if "%%1" == "doctest" ( if "%%1" == "doctest" (
\t%%SPHINXBUILD%% -b doctest %%ALLSPHINXOPTS%% %(rbuilddir)s/doctest \t%%SPHINXBUILD%% -b doctest %%ALLSPHINXOPTS%% %%BUILDDIR%%/doctest
\techo. \techo.
\techo.Testing of doctests in the sources finished, look at the ^ \techo.Testing of doctests in the sources finished, look at the ^
results in %(rbuilddir)s/doctest/output.txt. results in %%BUILDDIR%%/doctest/output.txt.
\tgoto end \tgoto end
) )