Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commitf094909

Browse files
committed
Add BUILDDIR var to doc/Makefile; have tox use it
This adds BUILDDIR as a variable in the documentation generationmakefile that, along SPHINXOPTS, SPHINXBUILD, and PAPER, defaultsto the usual best value but can be set when invoking make.The main use for choosing a different build output directory is totest building without overwriting or otherwise interfering with anyfiles from a build one may really want to use. tox.ini is thusmodified to pass a path pointing inside its temporary directory asBUILDDIR, so the "html" tox environment now makes no changesoutside the .tox directory. This is thus suitable for being runautomatically, so the "html" environment is now in the envlist.
1 parent6de86a8 commitf094909

File tree

2 files changed

+26
-25
lines changed

2 files changed

+26
-25
lines changed

‎doc/Makefile

Lines changed: 22 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,15 @@
22
#
33

44
# You can set these variables from the command line.
5+
BUILDDIR = build
56
SPHINXOPTS = -W
67
SPHINXBUILD = sphinx-build
78
PAPER =
89

910
# Internal variables.
1011
PAPEROPT_a4 = -D latex_paper_size=a4
1112
PAPEROPT_letter = -D latex_paper_size=letter
12-
ALLSPHINXOPTS = -dbuild/doctrees$(PAPEROPT_$(PAPER))$(SPHINXOPTS) source
13+
ALLSPHINXOPTS = -d$(BUILDDIR)/doctrees$(PAPEROPT_$(PAPER))$(SPHINXOPTS) source
1314

1415
.PHONY: help clean html web pickle htmlhelp latex changes linkcheck
1516

@@ -24,52 +25,52 @@ help:
2425
@echo" linkcheck to check all external links for integrity"
2526

2627
clean:
27-
-rm -rfbuild/*
28+
-rm -rf$(BUILDDIR)/*
2829

2930
html:
30-
mkdir -pbuild/htmlbuild/doctrees
31-
$(SPHINXBUILD) -b html$(ALLSPHINXOPTS)build/html
31+
mkdir -p$(BUILDDIR)/html$(BUILDDIR)/doctrees
32+
$(SPHINXBUILD) -b html$(ALLSPHINXOPTS)$(BUILDDIR)/html
3233
@echo
33-
@echo"Build finished. The HTML pages are inbuild/html."
34+
@echo"Build finished. The HTML pages are in$(BUILDDIR)/html."
3435

3536
pickle:
36-
mkdir -pbuild/picklebuild/doctrees
37-
$(SPHINXBUILD) -b pickle$(ALLSPHINXOPTS)build/pickle
37+
mkdir -p$(BUILDDIR)/pickle$(BUILDDIR)/doctrees
38+
$(SPHINXBUILD) -b pickle$(ALLSPHINXOPTS)$(BUILDDIR)/pickle
3839
@echo
3940
@echo"Build finished; now you can process the pickle files."
4041

4142
web: pickle
4243

4344
json:
44-
mkdir -pbuild/jsonbuild/doctrees
45-
$(SPHINXBUILD) -b json$(ALLSPHINXOPTS)build/json
45+
mkdir -p$(BUILDDIR)/json$(BUILDDIR)/doctrees
46+
$(SPHINXBUILD) -b json$(ALLSPHINXOPTS)$(BUILDDIR)/json
4647
@echo
4748
@echo"Build finished; now you can process the JSON files."
4849

4950
htmlhelp:
50-
mkdir -pbuild/htmlhelpbuild/doctrees
51-
$(SPHINXBUILD) -b htmlhelp$(ALLSPHINXOPTS)build/htmlhelp
51+
mkdir -p$(BUILDDIR)/htmlhelp$(BUILDDIR)/doctrees
52+
$(SPHINXBUILD) -b htmlhelp$(ALLSPHINXOPTS)$(BUILDDIR)/htmlhelp
5253
@echo
5354
@echo"Build finished; now you can run HTML Help Workshop with the"\
54-
".hhp project file inbuild/htmlhelp."
55+
".hhp project file in$(BUILDDIR)/htmlhelp."
5556

5657
latex:
57-
mkdir -pbuild/latexbuild/doctrees
58-
$(SPHINXBUILD) -b latex$(ALLSPHINXOPTS)build/latex
58+
mkdir -p$(BUILDDIR)/latex$(BUILDDIR)/doctrees
59+
$(SPHINXBUILD) -b latex$(ALLSPHINXOPTS)$(BUILDDIR)/latex
5960
@echo
60-
@echo"Build finished; the LaTeX files are inbuild/latex."
61+
@echo"Build finished; the LaTeX files are in$(BUILDDIR)/latex."
6162
@echo"Run\`make all-pdf' or\`make all-ps' in that directory to"\
6263
"run these through (pdf)latex."
6364

6465
changes:
65-
mkdir -pbuild/changesbuild/doctrees
66-
$(SPHINXBUILD) -b changes$(ALLSPHINXOPTS)build/changes
66+
mkdir -p$(BUILDDIR)/changes$(BUILDDIR)/doctrees
67+
$(SPHINXBUILD) -b changes$(ALLSPHINXOPTS)$(BUILDDIR)/changes
6768
@echo
68-
@echo"The overview file is inbuild/changes."
69+
@echo"The overview file is in$(BUILDDIR)/changes."
6970

7071
linkcheck:
71-
mkdir -pbuild/linkcheckbuild/doctrees
72-
$(SPHINXBUILD) -b linkcheck$(ALLSPHINXOPTS)build/linkcheck
72+
mkdir -p$(BUILDDIR)/linkcheck$(BUILDDIR)/doctrees
73+
$(SPHINXBUILD) -b linkcheck$(ALLSPHINXOPTS)$(BUILDDIR)/linkcheck
7374
@echo
7475
@echo"Link check complete; look for any errors in the above output"\
75-
"or inbuild/linkcheck/output.txt."
76+
"or in$(BUILDDIR)/linkcheck/output.txt."

‎tox.ini

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[tox]
22
requires = tox>=4
3-
env_list = py{37,38,39,310,311,312}, lint, mypy
3+
env_list = py{37,38,39,310,311,312}, lint, mypy, html
44

55
[testenv]
66
description = Run unit tests
@@ -22,11 +22,11 @@ base_python = py39
2222
commands = mypy -p git
2323
ignore_outcome = true
2424

25-
# Run "tox -e html" for this. It is deliberately excluded from env_list, as
26-
# unlike the other environments, this one writes outside the .tox/ directory.
2725
[testenv:html]
2826
description = Build HTML documentation
2927
base_python = py39
3028
deps = -r doc/requirements.txt
3129
allowlist_externals = make
32-
commands = make -C doc html
30+
commands =
31+
makeBUILDDIR={env_tmp_dir}/doc/build -C doc clean
32+
makeBUILDDIR={env_tmp_dir}/doc/build -C doc html

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp