diff options
| author | Takayuki Shimizukawa <shimizukawa+bitbucket@gmail.com> | 2014-07-05 09:21:16 +0900 |
|---|---|---|
| committer | Takayuki Shimizukawa <shimizukawa+bitbucket@gmail.com> | 2014-07-05 09:21:16 +0900 |
| commit | 982d5dc811ae4f145e02966bb68953b0ff541201 (patch) | |
| tree | c110434b747a7f1359329185e71424d75badb937 | |
| parent | 4bf71bf3df8b59d242bf291d2b3442b004013c47 (diff) | |
| parent | 3953dfbe41c295542c69d52fe2f1ac38842d5c1b (diff) | |
| download | sphinx-982d5dc811ae4f145e02966bb68953b0ff541201.tar.gz | |
Merged in mcmtroffaes/sphinx-make-coverage (pull request #159)
Add coverage targets to quickstart generated Makefile and make.bat.
| -rw-r--r-- | sphinx/quickstart.py | 18 |
1 files changed, 17 insertions, 1 deletions
diff --git a/sphinx/quickstart.py b/sphinx/quickstart.py index acf26df7..0e170261 100644 --- a/sphinx/quickstart.py +++ b/sphinx/quickstart.py @@ -460,7 +460,7 @@ $(SPHINXOPTS) %(rsrcdir)s I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) %(rsrcdir)s .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp \ -epub latex latexpdf text man changes linkcheck doctest gettext +epub latex latexpdf text man changes linkcheck doctest coverage gettext help: \t@echo "Please use \\`make <target>' where <target> is one of" @@ -487,6 +487,7 @@ help: \t@echo " linkcheck to check all external links for integrity" \t@echo " doctest to run all doctests embedded in the documentation \ (if enabled)" +\t@echo " coverage to check coverage of the documentation if enabled" clean: \trm -rf $(BUILDDIR)/* @@ -609,6 +610,11 @@ doctest: \t@echo "Testing of doctests in the sources finished, look at the " \\ \t "results in $(BUILDDIR)/doctest/output.txt." +coverage: +\t$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage +\t@echo "Documentation coverage is finished, look at the " \\ +\t "results in $(BUILDDIR)/coverage/python.txt." + xml: \t$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml \t@echo @@ -660,6 +666,7 @@ if "%%1" == "help" ( \techo. pseudoxml to make pseudoxml-XML files for display purposes \techo. linkcheck to check all external links for integrity \techo. doctest to run all doctests embedded in the documentation if enabled +\techo. coverage to check coverage of the documentation if enabled \tgoto end ) @@ -857,6 +864,15 @@ results in %%BUILDDIR%%/doctest/output.txt. \tgoto end ) +if "%%1" == "coverage" ( +\t%%SPHINXBUILD%% -b coverage %%ALLSPHINXOPTS%% %%BUILDDIR%%/coverage +\tif errorlevel 1 exit /b 1 +\techo. +\techo.Documentation coverage is finished, look at the ^ +results in %%BUILDDIR%%/coverage/python.txt. +\tgoto end +) + if "%%1" == "xml" ( \t%%SPHINXBUILD%% -b xml %%ALLSPHINXOPTS%% %%BUILDDIR%%/xml \tif errorlevel 1 exit /b 1 |