Skip to content

Commit b90457b

Browse files
committed
produce built docs in build/docs rather than docs/build
* build docs in a tmpdir to allow independant docs builds * you can now run `tox -e documentation,py38-test-dev ldaptor.test.test_usage` and check-manifest passes
1 parent f41dcde commit b90457b

File tree

3 files changed

+6
-5
lines changed

3 files changed

+6
-5
lines changed

.gitignore

-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ _trial_temp/
44
ldaptor.test.*/
55
ldaptor/test/ldif/webtests.tmp
66
docs/*.png
7-
docs/build/
87
ldaptor.egg-info
98
.idea
109
.coverage

CONTRIBUTING.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ Building the documentation
6464
--------------------------
6565

6666
The documentation is managed using Python Sphinx and is generated in
67-
docs/build.
67+
build/docs.
6868

6969
There is a helper to build the documentation using tox ::
7070

pyproject.toml

+5-3
Original file line numberDiff line numberDiff line change
@@ -73,10 +73,12 @@ commands =
7373
[testenv:documentation]
7474
deps = sphinx
7575
basepython=python3.8
76+
changedir = {envtmpdir}
77+
whitelist_externals = cp
7678
commands =
77-
mkdir -p docs/build
78-
sphinx-build -b html -Ean -j 2 -w build/sphinx-errors \
79-
docs/source docs/build
79+
sphinx-build -b html -Ean -j 2 -w sphinx-errors \
80+
{toxinidir}/docs/source ./docs/
81+
cp -r . {toxinidir}/build
8082
8183
[testenv:release]
8284
deps = pep517

0 commit comments

Comments
 (0)