1. Christopher Nilsson
  2. dirwatch

Commits

Christopher Nilsson  committed 0aa9be7

started on the docs...

  • Participants
  • Parent commits f7ce993
  • Branches default

Comments (0)

Files changed (5)

File dirwatch/eventtype.py

View file
-# Events supported by the watchers...
+""" Events supported by the EventManager.
+
+    File events:
+	EV_FILE_CREATED,
+	EV_FILE_DATA_CHANGED
+	EV_FILE_DELETED
+
+    Monitor events:
+	EV_MONITOR_STARTED
+	EV_MONITOR_STOPPED
+	EV_WATCH_ADDED
+"""
+
 
 EV_FILE_CREATED = "EV_FILE_CREATED"
 EV_FILE_DATA_CHANGED = "EV_FILE_DATA_CHANGED"

File doc/conf.py

View file
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.todo']
+extensions = ['sphinx.ext.todo', 'sphinx.ext.autodoc']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
 # General information about the project.
 project = u'dirwatch'
-copyright = u'2010, Chris Nilsson'
+copyright = u'2011, Chris Nilsson'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 epub_title = u'dirwatch'
 epub_author = u'Chris Nilsson'
 epub_publisher = u'Chris Nilsson'
-epub_copyright = u'2010, Chris Nilsson'
+epub_copyright = u'2011, Chris Nilsson'
 
 # The language of the text. It defaults to the language option
 # or en if the language is not set.

File doc/index.txt

View file
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to dirwatch's documentation!
-====================================
-
-Contents:
+.. contents:: Contents 
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
+
+   usage
+   module
+
+.. include:: ../README
 
 Indices and tables
 ==================

File doc/module.txt

View file
+
+dirwatch package 
+================
+
+.. contents: 
+
+
+base
+----
+.. automodule:: dirwatch.base
+   :members:
+   :undoc-members:
+
+
+nt_dirwatch
+-----------
+Aliased as ``dirwatch`` on windows.
+
+.. automodule:: dirwatch.nt_dirwatch
+   :members:
+   :undoc-members:
+
+
+eventmanager
+------------
+.. automodule:: dirwatch.eventmanager
+   :members:
+   :undoc-members:   
+
+eventtype
+---------
+Declares event IDs supported by the eventmanager_.
+
+* File events:
+
+  - EV_FILE_CREATED,
+
+  - EV_FILE_DATA_CHANGED,
+
+  - EV_FILE_DELETED
+
+* Monitor events:
+
+  - EV_MONITOR_STARTED,
+
+  - EV_MONITOR_STOPPED,
+
+  - EV_WATCH_ADDED

File doc/usage.txt

View file
+Usage
+-----