2015-05-18 09:27:00 -07:00
|
|
|
.. UPM Python documentation master file, created by Sisinty Sasmita Patra
|
2015-05-14 17:22:49 -07:00
|
|
|
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.
|
|
|
|
|
2015-06-03 09:32:05 -07:00
|
|
|
**Welcome to UPM Python Documentation!**
|
2015-05-14 17:22:49 -07:00
|
|
|
=========================================
|
|
|
|
|
|
|
|
.. include:: ../../README.md
|
|
|
|
:start-after: ==============
|
|
|
|
:end-before: ### Example
|
|
|
|
|
2015-05-18 09:27:00 -07:00
|
|
|
``Building UPM``
|
|
|
|
################
|
|
|
|
|
|
|
|
For building UPM, please follow this `link <https://github.com/intel-iot-devkit/upm/blob/master/docs/building.md>`_.
|
2015-06-03 09:32:05 -07:00
|
|
|
|
2015-05-18 09:27:00 -07:00
|
|
|
``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>`_.
|
|
|
|
|
2015-06-03 09:32:05 -07:00
|
|
|
``Naming Conventions and Rules for New UPM Contributions``
|
2015-05-18 09:27:00 -07:00
|
|
|
##########################################################
|
|
|
|
|
|
|
|
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>`_.
|
2015-05-14 17:22:49 -07:00
|
|
|
|
2015-05-18 09:27:00 -07:00
|
|
|
Don't forget to check the documentation `section <https://github.com/intel-iot-devkit/upm/blob/master/docs/documentation.md>`_.
|
|
|
|
|
|
|
|
.. note::
|
|
|
|
|
2015-06-03 09:32:05 -07:00
|
|
|
* 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.
|
2015-05-18 09:27:00 -07:00
|
|
|
* Signing-off your commits is mandatory.
|
|
|
|
|
2015-06-03 09:32:05 -07:00
|
|
|
``List of Available Sensors Drivers``
|
2015-05-18 09:27:00 -07:00
|
|
|
######################################
|
2015-05-14 17:22:49 -07:00
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
:maxdepth: 2
|
|
|
|
|
|
|
|
modules
|
|
|
|
|
2015-06-03 09:32:05 -07:00
|
|
|
``Other API Documentation``
|
2015-05-18 09:27:00 -07:00
|
|
|
###########################
|
|
|
|
|
2015-06-03 15:57:16 -07:00
|
|
|
.. image:: ../docs/c++.png
|
|
|
|
:target: http://iotdk.intel.com/docs/master/upm/
|
|
|
|
.. image:: ../docs/python.png
|
|
|
|
:target: http://iotdk.intel.com/docs/master/upm/python
|
|
|
|
.. image:: ../docs/node.png
|
|
|
|
:target: http://iotdk.intel.com/docs/master/upm/node
|
2015-05-18 09:27:00 -07:00
|
|
|
|
2015-06-03 09:32:05 -07:00
|
|
|
``Version Changelog``
|
|
|
|
#####################
|
2015-05-18 09:27:00 -07:00
|
|
|
|
2015-06-03 09:32:05 -07:00
|
|
|
For our Version Changelog, please see `here <https://github.com/intel-iot-devkit/upm/blob/master/docs/changelog.md>`_.
|
2015-05-14 17:22:49 -07:00
|
|
|
|
2015-06-03 09:32:05 -07:00
|
|
|
``Known Limitations``
|
2015-05-18 09:27:00 -07:00
|
|
|
###################################
|
2015-05-14 17:22:49 -07:00
|
|
|
|
2015-06-03 09:32:05 -07:00
|
|
|
For the List of Known Limitations, please see `here <https://github.com/intel-iot-devkit/upm/blob/master/docs/knownlimitations.md>`_.
|
2015-05-14 17:22:49 -07:00
|
|
|
|
2015-05-18 09:27:00 -07:00
|
|
|
``Indices and tables``
|
|
|
|
######################
|
2015-05-14 17:22:49 -07:00
|
|
|
|
|
|
|
* :ref:`genindex`
|
|
|
|
* :ref:`modindex`
|
|
|
|
* :ref:`search`
|