upm/doxy/index.rst

.. UPM Python documentation master file, created by Sisinty Sasmita Patra
   UPM Team on Thu May 14 15:58:46 2015.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

**Welcome to UPM Python documentation!**
=========================================

.. include:: ../../README.md
  :start-after: ==============
  :end-before: ### Example

``Building UPM``
################

For building UPM, please follow this `link <https://github.com/intel-iot-devkit/upm/blob/master/docs/building.md>`_.
   
``Making your own UPM Module``
##############################

This `link  <https://github.com/intel-iot-devkit/upm/blob/master/docs/porting.md>`_ has more information on making a new UPM module.

There is also an example available for max31855 `sensor <https://github.com/intel-iot-devkit/upm/blob/master/docs/max31855.md>`_.

``Naming Conventions and rules for new UPM Contributions``
##########################################################

Before you begin development, please take a look at our naming `conventions <https://github.com/intel-iot-devkit/upm/blob/master/docs/naming.md>`_.

Also, please read the guidelines for contributions to `UPM <https://github.com/intel-iot-devkit/upm/blob/master/docs/contributions.md>`_.

Don't forget to check the documentation `section <https://github.com/intel-iot-devkit/upm/blob/master/docs/documentation.md>`_.

.. note::

   * Make sure you add yourself as an author on every new code file submitted. 
   * If you are providing a fix with significant changes, feel free to add yourself as a contributor. 
   * Signing-off your commits is mandatory.

``List of available sensors drivers``
######################################

.. toctree::
   :maxdepth: 2

   modules

``C/C++ API Documentation``
###########################

The C/C++ API documentation is available `here <http://iotdk.intel.com/docs/master/upm/>`_.

``Version``
###########

For Version Changelog, please see `here <https://github.com/intel-iot-devkit/upm/blob/master/docs/changelog.md>`_.

``Limitations and List of Changes``
###################################

For List of Known Limitations, please see `here <https://github.com/intel-iot-devkit/upm/blob/master/docs/knownlimitations.md>`_.

``Indices and tables``
######################

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`