Skip to content

Commit 9433edc

Browse files
committed
Update development documentation for entr(1)
1 parent c6da252 commit 9433edc

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

doc/developing.rst

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -134,22 +134,25 @@ Run tests on save
134134
You can re-run tests automatically on file edit.
135135

136136
.. note::
137-
This requires and installation of ``sniffer`` from pypi.
137+
This requires ``entr(1)``.
138138

139-
Install `sniffer`_ from `pypi`_:
139+
Install `entr`_. Packages are available available on most Linux and BSD
140+
variants, including Debian, Ubuntu, FreeBSD, OS X.
141+
142+
To run all tests upon editing any ``.py`` file:
140143

141144
.. code-block:: bash
142145
143-
$ pip install sniffer
146+
$ find . -type f -not -path '*/\.*' | grep -i '.*[.]py$' | entr -c ./run-tests.py
144147
145-
To run all tests upon editing any ``.py`` file:
148+
.. _entr: http://entrproject.org/
146149

147-
.. code-block:: bash
150+
Rebuild the documentation when an ``.rst`` file is edited:
148151

149-
$ sniffer
152+
.. code-block:: bash
150153
151-
.. _sniffer: https://github.com/jeffh/sniffer
152-
.. _pypi: https://pypi.python.org/pypi
154+
$ cd doc
155+
$ find .. -print | grep -i '.*[.]rst' | entr -c make html
153156
154157
.. _tmuxp developer config:
155158

0 commit comments

Comments
 (0)