fan: added documentation

7 files changed, 690 insertions, 0 deletions

diff --git a/src/fan/doc/Makefile b/src/fan/doc/Makefile
new file mode 100644
index 0000000..82e33a6
--- /dev/null
+++ b/src/fan/doc/Makefile
@@ -0,0 +1,159 @@
+# 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) source
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp \
+	devhelp epub latex latexpdf text man changes linkcheck doctest \
+	gettext mof
+
+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)"
+
+mof:
+	make -C source/mof
+
+clean:
+	-rm -rf $(BUILDDIR)/*
+	make -C source/mof clean
+
+html: 	mof
+	$(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/OpenLMIFanProvider.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/OpenLMIFanProvider.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/OpenLMIFanProvider"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/OpenLMIFanProvider"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:  mof
+	$(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: mof
+	$(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."
diff --git a/src/fan/doc/source/conf.py b/src/fan/doc/source/conf.py
new file mode 100644
index 0000000..c9a9b8d
--- /dev/null
+++ b/src/fan/doc/source/conf.py
@@ -0,0 +1,294 @@
+# -*- coding: utf-8 -*-
+#
+# OpenLMI Fan Provider documentation build configuration file, created by
+# sphinx-quickstart on Thu Oct  3 14:25:59 2013.
+#
+# 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.
+
+import sys, os
+
+def setup(app):
+    # Register new option to include class list and class tree in index.rst
+    app.add_config_value('includeClasses', 'True', True)
+includeClasses = True
+
+# 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.
+#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.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.pngmath', 'sphinx.ext.ifconfig']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'OpenLMI Fan Provider'
+copyright = u'2013, Michal Minar'
+
+# 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 = '0.3.0'
+# The full version, including alpha/beta/rc tags.
+release = '0.3.0'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- 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 = 'openlmitheme'
+
+# 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 themes here, relative to this directory.
+html_theme_path = ["../../../../tools"]
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# 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']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'OpenLMIFanProviderdoc'
+
+
+# -- 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': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+  ('index', 'OpenLMIFanProvider.tex', u'OpenLMI Fan Provider Documentation',
+   u'Michal Minar', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'openlmifanprovider', u'OpenLMI Fan Provider Documentation',
+     [u'Michal Minar'], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- 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 = [
+  ('index', 'OpenLMIFanProvider', u'OpenLMI Fan Provider Documentation',
+   u'Michal Minar', 'OpenLMIFanProvider', 'One line description of project.',
+   'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
+
+
+# -- Options for Epub output ---------------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = u'OpenLMI Fan Provider'
+epub_author = u'Michal Minar'
+epub_publisher = u'Michal Minar'
+epub_copyright = u'2013, Michal Minar'
+
+# The language of the text. It defaults to the language option
+# or en if the language is not set.
+#epub_language = ''
+
+# The scheme of the identifier. Typical schemes are ISBN or URL.
+#epub_scheme = ''
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#epub_identifier = ''
+
+# A unique identification for the text.
+#epub_uid = ''
+
+# A tuple containing the cover image and cover page html template filenames.
+#epub_cover = ()
+
+# HTML files that should be inserted before the pages created by sphinx.
+# The format is a list of tuples containing the path and title.
+#epub_pre_files = []
+
+# HTML files shat should be inserted after the pages created by sphinx.
+# The format is a list of tuples containing the path and title.
+#epub_post_files = []
+
+# A list of files that should not be packed into the epub file.
+#epub_exclude_files = []
+
+# The depth of the table of contents in toc.ncx.
+#epub_tocdepth = 3
+
+# Allow duplicate toc entries.
+#epub_tocdup = True
+
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {'http://docs.python.org/': None}
diff --git a/src/fan/doc/source/dmtf.rst b/src/fan/doc/source/dmtf.rst
new file mode 100644
index 0000000..cb8234d
--- /dev/null
+++ b/src/fan/doc/source/dmtf.rst
@@ -0,0 +1,144 @@
+.. _dmtf_profiles:
+
+DMTF profiles
+=============
+*OpenLMI Fan* provider implements *Fan Profile*
+
+Fan Profile
+--------------------------
+Implemented *DMTF* version: ``1.0.1``
+
+Described by `DSP1013`_
+
+It defines the classes used to describe the fans and the possible redundancy
+of the fans in a managed system. The document also defines association
+classes that describe the relationship of the fan to the fan’s physical
+aspects (such as FRU data) to the sensors monitoring the fans, to other
+cooling devices, to redundancy status, and to DMTF profile version
+information. The information in this specification is intended to be
+sufficient for a provider or consumer of this data to identify unambiguously
+the classes, properties, methods, and values that are mandatory to be
+instantiated and manipulated to represent and manage fans and redundant fans
+of managed systems and subsystems that are modeled using the DMTF CIM core
+and extended model definitions.
+
+Not implemented features
+~~~~~~~~~~~~~~~~~~~~~~~~
+*DMTF* profile defines many classes that are not instrumented due to
+limitations of low level libraries giving informations about fans.
+Here is a list of not implemented classes:
+
+    ``CIM_ManagedSystemElement``
+        Models the piece of hardware being cooled by particular fan. It's
+        associated with :ref:`LMI_Fan<LMI-Fan>` through ``CIM_AssociatedColling`` which
+        is also not instrumented.
+
+    ``CIM_RedundancySet``
+        Represents redundacy of fans belonging to particular computer
+        system. It's associated with :ref:`LMI_Fan<LMI-Fan>` through
+        ``CIM_MemberOfCollection`` and ``CIM_IsSpare`` associations.
+        There is no way how to detect whether the fan is spare or not.
+
+Classes that shall be implemented
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+There are still classes missing implementation and are planned to
+be delivered in future versions.
+
+    ``CIM_SystemDevice``
+        Associates :ref:`LMI_Fan<LMI-Fan>` to ``CIM_ComputerSystem``.
+
+    ``CIM_EnabledLogicalElementCapacilities``
+        Represents the capabilities of associated fan. It's associated
+        to :ref:`LMI_Fan<LMI-Fan>` through ``CIM_ElementCapabilities``.
+
+Not implemented optional features
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+*Physical Asset* association from :ref:`LMI_Fan<LMI-Fan>` to ``CIM_PhysicalPackage``
+through ``CIM_Realizes`` association class is not instrumented.
+This is an optional feature. It may be implemented later.
+
+*Physical Asset* is a related profile implemented by *OpenLMI Hardware*
+provider.
+
+Class overview
+~~~~~~~~~~~~~~
+
+    +---------------------------------------------------------+---------------------------------------------------+------------------+
+    | Class-name                                              | Parent_class                                      | Type             |
+    +=========================================================+===================================================+==================+
+    | :ref:`LMI_Fan<LMI-Fan>`                                 | :ref:`CIM_Fan<CIM-Fan>`                           | Plain            |
+    +---------------------------------------------------------+---------------------------------------------------+------------------+
+    | :ref:`LMI_FanSensor<LMI-FanSensor>`                     | :ref:`CIM_NumericSensor<CIM-NumericSensor>`       | Plain            |
+    +---------------------------------------------------------+---------------------------------------------------+------------------+
+    | :ref:`LMI_FanAssociatedSensor<LMI-FanAssociatedSensor>` | :ref:`CIM_AssociatedSensor<CIM-AssociatedSensor>` | Association      |
+    +---------------------------------------------------------+---------------------------------------------------+------------------+
+
+LMI_Fan
+^^^^^^^
+Represents the the fan installed and connected to computer.
+One of the most important keys is :ref:`DeviceID<LMI-Fan-DeviceID>`. It's a
+*sys* path to kernel driver's abstraction for fan combined with its name.
+
+Typical sys directory for fan looks like this: ::
+
+    /sys/class/hwmon/hwmon1/device/
+    ├── driver -> ../../../bus/platform/drivers/thinkpad_hwmon
+    ├── fan1_input
+    ├── hwmon
+    │   └── hwmon1
+    │       ├── device -> ../../../thinkpad_hwmon
+    │       ├── power
+    │       │   ├── async
+    │       │   ├── autosuspend_delay_ms
+    │       │   ├── control
+    │       │   ├── runtime_active_kids
+    │       │   ├── runtime_active_time
+    │       │   ├── runtime_enabled
+    │       │   ├── runtime_status
+    │       │   ├── runtime_suspended_time
+    │       │   └── runtime_usage
+    │       ├── subsystem -> ../../../../../class/hwmon
+    │       └── uevent
+    ├── modalias
+    ├── name
+    ├── power
+    │   ├── async
+    │   ├── autosuspend_delay_ms
+    │   ├── control
+    │   ├── runtime_active_kids
+    │   ├── runtime_active_time
+    │   ├── runtime_enabled
+    │   ├── runtime_status
+    │   ├── runtime_suspended_time
+    │   └── runtime_usage
+    ├── pwm1
+    ├── pwm1_enable
+    ├── subsystem -> ../../../bus/platform
+    └── uevent
+
+Corresponding ``DeviceID`` is ``/sys/class/hwmon/hwmon1/device/fan1``. The fan
+name is the prefix of ``*_input`` file which gives the current
+:abbr:`RPM(Revolutions per minute)` value.
+
+It has several other interesting properties:
+
+    :ref:`OtherIdentifyingInfo<CIM-LogicalDevice-OtherIdentifyingInfo>` : ``string []``
+        Has the name of chip controlling the fan as the first item.
+
+LMI_FanSensor
+^^^^^^^^^^^^^
+Represents a sensor measuring a speed of particular fan. It's exactly the same
+keys and values except for
+:ref:`CreationClassName<CIM-LogicalDevice-CreationClassName>` containg the name
+of corresponding class ``LMI_Fan``.
+
+It inherts many methods that are not supported because underlying library does
+not offer such functionality. Controlling of fans is very hardware dependent.
+Different drivers may provide different ways and possibilities to manage
+connected fans.
+    
+..
+    ***************************************************************************
+
+.. _DSP1013: http://www.dmtf.org/sites/default/files/standards/documents/DSP1013_1.0.1.pdf
+
diff --git a/src/fan/doc/source/index.rst b/src/fan/doc/source/index.rst
new file mode 100644
index 0000000..35e57c3
--- /dev/null
+++ b/src/fan/doc/source/index.rst
@@ -0,0 +1,27 @@
+.. OpenLMI Software Provider documentation master file, created by
+   sphinx-quickstart on Thu Oct  3 14:25:59 2013.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to OpenLMI Software Provider's documentation!
+=====================================================
+
+Contents:
+
+.. toctree::
+    :maxdepth: 2
+
+    dmtf
+    usage
+
+.. ifconfig:: includeClasses
+
+   OpenLMI Storage CIM classes:
+
+   .. toctree::
+      :maxdepth: 1
+
+      mof/tree
+      mof/index
+
+
diff --git a/src/fan/doc/source/mof/Makefile b/src/fan/doc/source/mof/Makefile
new file mode 100644
index 0000000..ac49af8
--- /dev/null
+++ b/src/fan/doc/source/mof/Makefile
@@ -0,0 +1,15 @@
+src: index.rst
+
+TOPDIR=../../../../..
+MOFS=$(TOPDIR)/mof/60_LMI_Fan.mof
+
+index.rst: $(MOFS)
+	$(TOPDIR)/tools/openlmi-doc-class2rst -H header.txt \
+	    -M `echo $(MOFS) | sed 's/ / -M /g'` \
+	    -S /usr/share/mof/cim-current/CIM_Schema.mof \
+	    -S $(TOPDIR)/mof/05_LMI_Qualifiers.mof \
+	    -S $(TOPDIR)/mof/30_LMI_Jobs.mof \
+	    `cat $(MOFS) | grep "^class" | cut -d ' ' -f 2 | sed 's/://'`
+
+clean:
+	rm -f *.rst
diff --git a/src/fan/doc/source/plantuml.cfg b/src/fan/doc/source/plantuml.cfg
new file mode 100644
index 0000000..ddf57e7
--- /dev/null
+++ b/src/fan/doc/source/plantuml.cfg
@@ -0,0 +1,3 @@
+skinparam defaultFontName Monospace
+skinparam defaultFontSize 10
+
diff --git a/src/fan/doc/source/usage.rst b/src/fan/doc/source/usage.rst
new file mode 100644
index 0000000..3a34b51
--- /dev/null
+++ b/src/fan/doc/source/usage.rst
@@ -0,0 +1,48 @@
+*OpenLMI Fan* usage
+===================
+Examples for common use cases listed below are written in `lmishell`_.
+
+Set up
+------
+*OpenLMI Fan* provider uses `lm-sensors`_ to find, observe and manage installed
+fans. In order to make the fans exposed to it, one operation needs to be done:
+
+.. code-block:: sh
+
+    sensors-detect
+
+``sensors-detect`` is a script shiped with ``lm_sensors`` package in *Fedora*
+which tries to load correct modules for various sensor devices found in system.
+It also writes a config used by ``sensors`` library which is utilised in this
+provider. Please refer to its *sensors-detect (8)* man-page.
+
+Examples
+--------
+Listing installed fans
+~~~~~~~~~~~~~~~~~~~~~~
+::
+
+    c = connect("host", "user", "pass")
+    for fan in c.root.cimv2.LMI_Fan.instances():
+        print(fan.ElementName)
+
+.. seealso::
+    :ref:`LMI_Fan<LMI-Fan>`
+
+Getting fan's speed
+~~~~~~~~~~~~~~~~~~~
+Current value can be read from :ref:`CurrentReading<CIM-NumericSensor-CurrentReading>`
+property. It's measured in *revolutions per minute*.
+
+::
+
+        c = connect("host", "user", "pass")
+        for fan in c.root.cimv2.LMI_FanSensor.instances():
+            print("%s:\t%s RPM" % (fan.Name, fan.CurrentReading))
+
+.. seealso::
+    :ref:`LMI_FanSensor<LMI-FanSensor>`
+
+.. *****************************************************************************
+.. _lmishell:      https://fedorahosted.org/openlmi/wiki/shell
+.. _lm-sensors: http://lm-sensors.org/