diff --git a/docs/Makefile b/docs/Makefile
new file mode 100644
index 0000000000000000000000000000000000000000..3f59bbf07af0795c985b79dcaa75fd805e06c5c7
--- /dev/null
+++ b/docs/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = sphinx-build
+SPHINXPROJ = satella
+SOURCEDIR = .
+BUILDDIR = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+ @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+ @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
\ No newline at end of file
diff --git a/docs/coding/monitor.md b/docs/coding/monitor.md
new file mode 100644
index 0000000000000000000000000000000000000000..dc83af6e6dadcedef30d7f0060cb9bd5d20bb11c
--- /dev/null
+++ b/docs/coding/monitor.md
@@ -0,0 +1,42 @@
+# Monitor
+
+A monitor is a Java-like synchronization idea. Inheriting from _Monitor_ outfits the class with a Lock
+(or a reentrant lock, if _RMonitor_ is used), that can be used to coordinate access to some shared resource.
+
+Take care to invoke _Monitor's_ constructor when inheriting, or this won't work.
+
+You can decorate your methods with _Monitor.synchronized_ to have them execute with the lock acquired.
+If you have such a method, you can also temporarily release the lock using context manager _Monitor.release_
+(it will be reacquired) when context manager is exited.
+
+You can also use manual synchronization with context manager _Monitor.acquire_.
+
+```python
+from satella.coding import Monitor
+
+
+class MyProtectedClass(Monitor):
+ def __init__(self, *args):
+ super(Monitor, self).__init__()
+
+ @Monitor.synchronized
+ def synchronized(self):
+ pass # everything here is executed with class lock acquired
+
+ @Monitor.synchronized
+ def temporary_release(self):
+ pass # lock is acquired here
+ with Monitor.release(self):
+ pass # lock is NOT ACQUIRED here
+ pass # and here it's reacquired again
+
+ def manual_sync(self):
+ pass # not synchronized
+ with Monitor.acquire(self):
+ pass # synchronized
+
+```
+
+You can also use _Monitor.release_ and _Monitor.acquire_ with other objects than self, but exercise
+caution and think over the consequences.
+
diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644
index 0000000000000000000000000000000000000000..d95d1e912e54363ea2c4fa1975f5803757c1bb76
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,161 @@
+# -*- coding: utf-8 -*-
+#
+# satella documentation build configuration file, created by
+# sphinx-quickstart on Sun Jan 29 06:35:17 2017.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# 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.autodoc']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+
+from recommonmark.parser import CommonMarkParser
+
+source_parsers = {
+ '.md': CommonMarkParser
+}
+
+source_suffix = ['.rst', '.md']
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'satella'
+copyright = u'2017, Piotr Maslanka'
+author = u'Piotr Maslanka'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = u'2.0'
+# The full version, including alpha/beta/rc tags.
+release = u'2.0-rc'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages. See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'alabaster'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further. For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'satelladoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+ # The paper size ('letterpaper' or 'a4paper').
+ #
+ # 'papersize': 'letterpaper',
+
+ # The font size ('10pt', '11pt' or '12pt').
+ #
+ # 'pointsize': '10pt',
+
+ # Additional stuff for the LaTeX preamble.
+ #
+ # 'preamble': '',
+
+ # Latex figure (float) alignment
+ #
+ # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+# author, documentclass [howto, manual, or own class]).
+latex_documents = [
+ (master_doc, 'satella.tex', u'satella Documentation',
+ u'Piotr Maslanka', 'manual'),
+]
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+ (master_doc, 'satella', u'satella Documentation',
+ [author], 1)
+]
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+# dir menu entry, description, category)
+texinfo_documents = [
+ (master_doc, 'satella', u'satella Documentation',
+ author, 'satella', 'One line description of project.',
+ 'Miscellaneous'),
+]
+
+
+
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 0000000000000000000000000000000000000000..a79e1d7aee61e3be4b4a8f31c1c0c8b843d1c264
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,16 @@
+Welcome to satella's documentation!
+===================================
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Contents:
+
+ coding/monitor
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/docs/make.bat b/docs/make.bat
new file mode 100644
index 0000000000000000000000000000000000000000..efa1dc41aec9666462905ff0450ac278efce789b
--- /dev/null
+++ b/docs/make.bat
@@ -0,0 +1,36 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+ set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+set SPHINXPROJ=satella
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+ echo.
+ echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+ echo.installed, then set the SPHINXBUILD environment variable to point
+ echo.to the full path of the 'sphinx-build' executable. Alternatively you
+ echo.may add the Sphinx directory to PATH.
+ echo.
+ echo.If you don't have Sphinx installed, grab it from
+ echo.http://sphinx-doc.org/
+ exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd
diff --git a/satella/coding/__init__.py b/satella/coding/__init__.py
index c6ce28bc5331fe40c8cc9fe5945fdee4fd1b574c..180611605ab4f55b6692b8fc45f75d47d8895ae1 100644
--- a/satella/coding/__init__.py
+++ b/satella/coding/__init__.py
@@ -3,6 +3,7 @@
Just useful objects to make your coding nicer every day
"""
from __future__ import print_function, absolute_import, division
+import functools
import six
import threading
@@ -103,14 +104,14 @@ class Monitor(object):
self._monitor_lock = threading.Lock()
@staticmethod
- def protect(fun):
+ def synchronized(fun):
"""
This is a decorator. Class method decorated with that will lock the
global lock of given instance, making it threadsafe. Depending on
usage pattern of your class and it's data semantics, your performance
may vary
"""
-
+ @functools.wraps(fun)
def monitored(*args, **kwargs):
with args[0]._monitor_lock:
return fun(*args, **kwargs)
@@ -126,8 +127,7 @@ class Monitor(object):
but you feel that you can release it for a while as it would
improve parallelism. You can use it as such:
-
- @Monitor.protect
+ @Monitor.synchronized
def protected_function(self):
.. do some stuff that needs mutual exclusion ..
with Monitor.release(self):