Skip to content

Commit a811464

Browse files
committed
Review Sphinx config.
1 parent e623b42 commit a811464

File tree

3 files changed

+103
-205
lines changed

3 files changed

+103
-205
lines changed

Makefile

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@ doc-html: .version
1717
clean:
1818
rm -f *~ tests/*~
1919
rm -rf build
20-
$(MAKE) -C doc clean
2120

2221
distclean: clean
2322
rm -rf .cache tests/.cache .pytest_cache tests/.pytest_cache

doc/Makefile

Lines changed: 17 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,27 @@
1-
# Makefile for Sphinx documentation
2-
#
3-
4-
# You can set these variables from the command line.
51
SPHINXOPTS =
62
SPHINXBUILD = sphinx-build
7-
PAPER = a4
8-
9-
# Internal variables.
10-
PAPEROPT_a4 = -D latex_paper_size=a4
11-
PAPEROPT_letter = -D latex_paper_size=letter
12-
ALLSPHINXOPTS = -d doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) src
13-
14-
# Subdirectories of src that are supposed to be there but that may be
15-
# empty and may thus be missing after a git checkout.
16-
SRCDIRS = src/_static src/_templates
17-
3+
SPHINXPROJ = pytest-dependency
4+
SOURCEDIR = src
5+
BUILDDIR = .
6+
BUILDERS = html dirhtml singlehtml htmlhelp qthelp devhelp epub \
7+
latex latexpdf man texinfo text gettext linkcheck xml \
8+
json pickle
189

19-
html: $(SRCDIRS)
20-
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) html
10+
# Subdirectories of the source directory that are supposed to be there
11+
# but that may be empty and may thus be missing after a git checkout.
12+
STATIC_SOURCEDIRS = $(SOURCEDIR)/_static $(SOURCEDIR)/_templates
2113

22-
latex: $(SRCDIRS)
23-
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) latex
2414

25-
latexpdf: latex
26-
$(MAKE) -C latex all-pdf
15+
help:
16+
$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
2717

28-
linkcheck: $(SRCDIRS)
29-
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) linkcheck
18+
$(BUILDERS): $(STATIC_SOURCEDIRS)
19+
$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
3020

31-
doctest: $(SRCDIRS)
32-
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) doctest
33-
34-
clean:
35-
rm -f *~ examples/*~ src/*~
36-
37-
distclean: clean
38-
rm -rf doctrees html latex linkcheck doctest
39-
rm -f examples/*.pyc
40-
rm -rf examples/__pycache__
41-
42-
src/_static:
43-
mkdir $@
21+
distclean:
22+
rm -rf doctrees $(BUILDERS)
4423

45-
src/_templates:
24+
$(STATIC_SOURCEDIRS):
4625
mkdir $@
4726

48-
.PHONY: html latex latexpdf linkcheck doctest clean distclean
27+
.PHONY: help distclean $(BUILDERS)

0 commit comments

Comments
 (0)