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

Merged in mcmtroffaes/sphinx-make-coverage (pull request #159)

Browse Source 
Add coverage targets to quickstart generated Makefile and make.bat.
This commit is contained in:
Takayuki Shimizukawa 2014-07-05 09:21:16 +09:00
commit b1a24fab86
1 changed files with 17 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
sphinx/quickstart.py
View File

@ -460,7 +460,7 @@ $(SPHINXOPTS) %(rsrcdir)s
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) %(rsrcdir)s I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) %(rsrcdir)s
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp \ .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: help:
\t@echo "Please use \\`make <target>' where <target> is one of" \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 " linkcheck to check all external links for integrity"
\t@echo " doctest to run all doctests embedded in the documentation \ \t@echo " doctest to run all doctests embedded in the documentation \
(if enabled)" (if enabled)"
\t@echo " coverage to check coverage of the documentation if enabled"
clean: clean:
\trm -rf $(BUILDDIR)/* \trm -rf $(BUILDDIR)/*
@ -609,6 +610,11 @@ 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 $(BUILDDIR)/doctest/output.txt." \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: xml:
\t$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml \t$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
\t@echo \t@echo
@ -660,6 +666,7 @@ if "%%1" == "help" (
\techo. pseudoxml to make pseudoxml-XML files for display purposes \techo. pseudoxml to make pseudoxml-XML files for display purposes
\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 \techo. doctest to run all doctests embedded in the documentation if enabled
\techo. coverage to check coverage of the documentation if enabled
\tgoto end \tgoto end
) )
@ -857,6 +864,15 @@ results in %%BUILDDIR%%/doctest/output.txt.
\tgoto end \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" ( if "%%1" == "xml" (
\t%%SPHINXBUILD%% -b xml %%ALLSPHINXOPTS%% %%BUILDDIR%%/xml \t%%SPHINXBUILD%% -b xml %%ALLSPHINXOPTS%% %%BUILDDIR%%/xml
\tif errorlevel 1 exit /b 1 \tif errorlevel 1 exit /b 1