Skip to content

Commit 74c8f32

Browse files
committed
Add docs on example usage.
1 parent 0187bd8 commit 74c8f32

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,3 +90,18 @@ To install with ``pip``:
9090
$ python -m pip install git+https://github.com/domdfcoding/tox-recreate-hook
9191
9292
.. end installation
93+
94+
95+
Example configuration
96+
97+
.. code-block:: ini
98+
99+
[testenv:docs]
100+
setenv = SHOW_TODOS = 1
101+
basepython = python3.8
102+
changedir = {toxinidir}/doc-source
103+
deps =
104+
-r{toxinidir}/requirements.txt
105+
-r{toxinidir}/doc-source/requirements.txt
106+
commands = sphinx-build -M html . ./build {posargs}
107+
recreate_hook = builtin.rmdir("{toxinidir}/doc-source/build")

0 commit comments

Comments
 (0)