blob: 903930624580f677f76d1d4c6ab7127c41be95ef [file] [log] [blame]
.. watchdog documentation master file, created by
sphinx-quickstart on Tue Nov 30 00:43:58 2010.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
.. include:: global.rst.inc
Watchdog
========
Python API library and shell utilities to monitor file system events.
|project_name| is 2 things:
* Cross-platform Python API library for monitoring file system changes.
* Suite of shell utilities that monitor file system changes
and execute other shell commands in response.
Contents:
.. toctree::
:maxdepth: 2
install
quickstart
Modules and API
===============
.. toctree::
:maxdepth: 2
modules/watchdog.events
modules/watchdog.utils.collections
modules/watchdog.observers.polling_observer
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`