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

add doctest quickstart target.

Browse Source
This commit is contained in:
Georg Brandl 2009-01-22 20:29:38 +01:00
parent 0dd23c2dc1
commit 655ae6d89e
1 changed files with 16 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
sphinx/quickstart.py
View File

@ -257,7 +257,7 @@ PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d %(rbuilddir)s/doctrees $(PAPEROPT_$(PAPER)) \ ALLSPHINXOPTS = -d %(rbuilddir)s/doctrees $(PAPEROPT_$(PAPER)) \
$(SPHINXOPTS) %(rsrcdir)s $(SPHINXOPTS) %(rsrcdir)s
.PHONY: help clean html pickle json htmlhelp qthelp latex changes linkcheck .PHONY: help clean html pickle json htmlhelp qthelp latex changes linkcheck doctest
help: help:
\t@echo "Please use \\`make <target>' where <target> is one of" \t@echo "Please use \\`make <target>' where <target> is one of"
@ -269,6 +269,7 @@ help:
\t@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" \t@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
\t@echo " changes to make an overview over all changed/added/deprecated items" \t@echo " changes to make an overview over all changed/added/deprecated items"
\t@echo " linkcheck to check all external links for integrity" \t@echo " linkcheck to check all external links for integrity"
\t@echo " doctest to run all doctests embedded in the documentation (if enabled)"
clean: clean:
\t-rm -rf %(rbuilddir)s/* \t-rm -rf %(rbuilddir)s/*
@ -320,6 +321,11 @@ 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 %(rbuilddir)s/linkcheck/output.txt."
doctest:
\t$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) %(rbuilddir)s/doctest
\t@echo "Testing of doctests in the sources finished, look at the " \\
\t "results in %(rbuilddir)s/doctest/output.txt."
''' '''
BATCHFILE = '''\ BATCHFILE = '''\
@ -346,6 +352,7 @@ if "%%1" == "help" (
\techo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter \techo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
\techo. changes to make an overview over all changed/added/deprecated items \techo. changes to make an overview over all changed/added/deprecated items
\techo. linkcheck to check all external links for integrity \techo. linkcheck to check all external links for integrity
\techo. doctest to run all doctests embedded in the documentation (if enabled)
\tgoto end \tgoto end
) )
@ -417,6 +424,14 @@ or in %(rbuilddir)s/linkcheck/output.txt.
\tgoto end \tgoto end
) )
if "%%1" == "doctest" (
\t%%SPHINXBUILD%% -b doctest %%ALLSPHINXOPTS%% %(rbuilddir)s/doctest
\techo.
\techo.Testing of doctests in the sources finished, look at the ^
results in %(rbuilddir)s/doctest/output.txt.
\tgoto end
)
:end :end
''' '''