Permalink
Browse files

add base docs

  • Loading branch information...
cyberdelia committed Apr 14, 2012
1 parent 583b132 commit 9d41d8a10b5d8ea8663af89a9b0bda16c5489e5f
Showing with 83 additions and 9 deletions.
  1. +11 −9 docs/index.rst
  2. +13 −0 docs/installation.rst
  3. +42 −0 docs/instruments.rst
  4. +17 −0 docs/reporters.rst
View
@@ -1,20 +1,22 @@
-.. metrology documentation master file, created by
- sphinx-quickstart on Thu Mar 22 11:40:53 2012.
- You can adapt this file completely to your liking, but it should at least
- contain the root `toctree` directive.
+Introduction
+============
-Welcome to metrology's documentation!
-=====================================
+A library to easily measure what's going on in your python.
-Contents:
+You can report bugs and discuss features on the `issues page <https://github.com/cyberdelia/metrology/issues>`_.
+
+Table Of Contents
+=================
.. toctree::
:maxdepth: 2
+ installation
+ instruments
+ reporters
+
Indices and tables
==================
-* :ref:`genindex`
-* :ref:`modindex`
* :ref:`search`
View
@@ -0,0 +1,13 @@
+.. _ref-installation:
+
+============
+Installation
+============
+
+1. Either check out Metrology from GitHub_ or to pull a release off PyPI_ ::
+
+ pip install metrology
+
+
+.. _GitHub: http://github.com/cyberdelia/metrology
+.. _PyPI: http://pypi.python.org/pypi/metrology
View
@@ -0,0 +1,42 @@
+.. _ref-instruments:
+
+===========
+Instruments
+===========
+
+Counters
+========
+
+::
+
+ counter = Metrology.counter('call')
+ counter.increment()
+
+Meters
+======
+
+::
+
+ meter = Metrology.meter('request')
+ meter.mark()
+
+
+Timers
+======
+
+::
+
+ timer = Metrology.timer('request')
+ with timer:
+ do_something()
+
+
+Utilization Timers
+==================
+
+::
+
+ utimer = Metrology.utilization_timer('request')
+ with utimer:
+ do_something()
+
View
@@ -0,0 +1,17 @@
+.. _ref-reporters:
+
+=========
+Reporters
+=========
+
+Graphite
+========
+
+Librato
+=======
+
+Logging
+=======
+
+Statsd
+======

0 comments on commit 9d41d8a

Please sign in to comment.