Permalink
Browse files

First pass at proper docs.

  • Loading branch information...
James Socol
James Socol committed Apr 10, 2012
1 parent fca4db8 commit bec939f9a958c61a6bad20c4cce840a90f3d7eeb
Showing with 1,060 additions and 85 deletions.
  1. +2 −0 MANIFEST.in
  2. +8 −85 README.rst
  3. +153 −0 docs/Makefile
  4. +242 −0 docs/conf.py
  5. +100 −0 docs/configure.rst
  6. +26 −0 docs/index.rst
  7. +190 −0 docs/make.bat
  8. +145 −0 docs/reference.rst
  9. +68 −0 docs/timing.rst
  10. +126 −0 docs/types.rst
View
@@ -1 +1,3 @@
include AUTHORS CHANGES LICENSE MANIFEST.in README.rst
+include setup.py
+recursive-include docs *
View
@@ -2,11 +2,10 @@
A Python statsd client
======================
-`statsd <https://github.com/etsy/statsd>`_ is a friendly front-end to `Graphite
-<http://graphite.wikidot.com/>`_. This is a Python client for the statsd
-daemon.
+statsd_ is a friendly front-end to Graphite_. This is a Python client for the
+statsd daemon.
-To use::
+Quickly, to use::
>>> import statsd
>>> c = statsd.StatsClient('localhost', 8125)
@@ -40,87 +39,11 @@ Or from source::
$ python setup.py install
-In Django
-=========
+Docs
+====
-If you're lucky enough to be using statsd in Django, you can configure a
-default client in your settings module with two values. The defaults are::
+There are lots of docs in the ``docs/`` directory.
- STATSD_HOST = 'localhost'
- STATSD_PORT = 8125
-Then instead of instantiating a new client every time, you can just grab::
-
- >>> from statsd import statsd
- >>> statsd.incr('foo')
-
-You can even set a prefix (optionally)::
-
- STATSD_PREFIX = 'foo'
-
-This can help differentiate between environments, like dev, staging, and
-production.
-
-
-Context Manager
-===============
-
-You can use a ``StatsClient`` instance as a context manager to easily time
-sections of code with the ``timer()`` method::
-
- >>> from statsd import statsd
- >>> with statsd.timer('bar'):
- ... func()
- ... func()
-
-When the managed block exits, the client will automatically send the time it
-took to statsd.
-
-If you'd like to catpure the elapsed time, add a variable to the ``with``
-block::
-
- >>> from statsd import statsd
- >>> with statsd.timer('bar') as timer:
- ... func()
- >>> print timer.ms # Elapsed time in milliseconds.
-
-
-Decorator
-=========
-
-You can *also* use a ``StatsClient`` instance as a decorator, also with the
-``timer()`` method::
-
- >>> from statsd import statsd
- >>> @statsd.timer('bar')
- ... def foo():
- ... pass
-
-Every time ``foo()`` is called, timing information will be sent to the stat
-``bar``.
-
-
-Sample Rates
-============
-
-All methods support an optional ``rate`` (kw)arg. This is a float between 0 and
-1 that specifies what fraction of data to send through (for a specific call).
-Sample rates are recorded by statsd.
-
-For example, here ``foo`` will be incremented approximately 50% of the time::
-
- >>> from statsd import statsd
- >>> statsd.incr('foo', 1, rate=0.5)
-
-Statsd understands that this is a 50% sample rate and will adjust accordingly.
-
-Similarly with ``decr()`` and timings::
-
- >>> from statsd import statsd
- >>> statsd.decr('foo', 1, rate=0.5)
- >>> statsd.timing('foo', 320, rate=0.25)
- >>> with statsd.timer('bar', rate=0.1):
- ... pass
- >>> @statsd.timer('bar', rate=0.5)
- ... def foo():
- ... pass
+.. _statsd: https://github.com/etsy/statsd
+.. _Graphite: http://graphite.wikidot.com/
View
@@ -0,0 +1,153 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = sphinx-build
+PAPER =
+BUILDDIR = _build
+
+# Internal variables.
+PAPEROPT_a4 = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+help:
+ @echo "Please use \`make <target>' where <target> is one of"
+ @echo " html to make standalone HTML files"
+ @echo " dirhtml to make HTML files named index.html in directories"
+ @echo " singlehtml to make a single large HTML file"
+ @echo " pickle to make pickle files"
+ @echo " json to make JSON files"
+ @echo " htmlhelp to make HTML files and a HTML help project"
+ @echo " qthelp to make HTML files and a qthelp project"
+ @echo " devhelp to make HTML files and a Devhelp project"
+ @echo " epub to make an epub"
+ @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+ @echo " latexpdf to make LaTeX files and run them through pdflatex"
+ @echo " text to make text files"
+ @echo " man to make manual pages"
+ @echo " texinfo to make Texinfo files"
+ @echo " info to make Texinfo files and run them through makeinfo"
+ @echo " gettext to make PO message catalogs"
+ @echo " changes to make an overview of all changed/added/deprecated items"
+ @echo " linkcheck to check all external links for integrity"
+ @echo " doctest to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+ -rm -rf $(BUILDDIR)/*
+
+html:
+ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+ $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+ $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+ @echo
+ @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+ $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+ @echo
+ @echo "Build finished; now you can process the pickle files."
+
+json:
+ $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+ @echo
+ @echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+ $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+ @echo
+ @echo "Build finished; now you can run HTML Help Workshop with the" \
+ ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+ $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+ @echo
+ @echo "Build finished; now you can run "qcollectiongenerator" with the" \
+ ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+ @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/PythonStatsD.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/PythonStatsD.qhc"
+
+devhelp:
+ $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+ @echo
+ @echo "Build finished."
+ @echo "To view the help file:"
+ @echo "# mkdir -p $$HOME/.local/share/devhelp/PythonStatsD"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/PythonStatsD"
+ @echo "# devhelp"
+
+epub:
+ $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+ @echo
+ @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo
+ @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+ @echo "Run \`make' in that directory to run these through (pdf)latex" \
+ "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo "Running LaTeX files through pdflatex..."
+ $(MAKE) -C $(BUILDDIR)/latex all-pdf
+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+ $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+ @echo
+ @echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+ $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+ @echo
+ @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+ @echo
+ @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+ @echo "Run \`make' in that directory to run these through makeinfo" \
+ "(use \`make info' here to do that automatically)."
+
+info:
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+ @echo "Running Texinfo files through makeinfo..."
+ make -C $(BUILDDIR)/texinfo info
+ @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+ $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+ @echo
+ @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+ $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+ @echo
+ @echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+ $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+ @echo
+ @echo "Link check complete; look for any errors in the above output " \
+ "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+ $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+ @echo "Testing of doctests in the sources finished, look at the " \
+ "results in $(BUILDDIR)/doctest/output.txt."
Oops, something went wrong.

0 comments on commit bec939f

Please sign in to comment.