1 .. UPM Python documentation master file, created by Sisinty Sasmita Patra 2 UPM Team on Thu May 14 15:58:46 2015. 3 You can adapt this file completely to your liking, but it should at least 4 contain the root `toctree` directive. 5 6 **Welcome to UPM Python Documentation!** 7 ========================================= 8 9 .. include:: ../../README.md 10 :start-after: ============== 11 :end-before: ### Example 12 13 ``Building UPM`` 14 ################ 15 16 For building UPM, please follow this `link <https://github.com/intel-iot-devkit/upm/blob/master/docs/building.md>`_. 17 18 ``Examples`` 19 ############ 20 21 Multi-sensor samples for the starter and specialized kits can be found in the `iot-devkit-samples <https://github.com/intel-iot-devkit/iot-devkit-samples>`_ 22 repository. 23 24 Individual sensor usage examples for Python are available `here <https://github.com/intel-iot-devkit/upm/tree/master/examples/python>`_. 25 26 ``IDE Compatibility`` 27 ################ 28 29 While there is no official IDE provided with our Python libraries, we do recommend the web-based IDE Wyliodrin. It can be used with multiple programming 30 languages, including Python. More information can be found on the Intel Developer Zone IDE page. 31 32 .. image:: ../docs/icons/wyliodrin.png 33 :target: https://software.intel.com/iot/software/ide 34 35 ``Making your own UPM Module`` 36 ############################## 37 38 This `link <https://github.com/intel-iot-devkit/upm/blob/master/docs/porting.md>`_ has more information on making a new UPM module. 39 40 There is also an example available for max31855 `sensor <https://github.com/intel-iot-devkit/upm/blob/master/docs/max31855.md>`_. 41 42 ``Naming Conventions and Rules for New UPM Contributions`` 43 ########################################################## 44 45 Before you begin development, please take a look at our naming `conventions <https://github.com/intel-iot-devkit/upm/blob/master/docs/naming.md>`_. 46 47 Also, please read the guidelines for contributions to `UPM <https://github.com/intel-iot-devkit/upm/blob/master/docs/contributions.md>`_. 48 49 Don't forget to check the documentation `section <https://github.com/intel-iot-devkit/upm/blob/master/docs/documentation.md>`_. 50 51 .. note:: 52 53 * Make sure you add yourself as an author on every new code file submitted. 54 * If you are providing a fix with significant changes, feel free to add yourself as a contributor. 55 * Signing-off your commits is mandatory. 56 57 ``List of Available Sensors Drivers`` 58 ###################################### 59 60 Click on the library prefix below to expand the full list of sensors: 61 62 .. toctree:: 63 :maxdepth: 1 64 65 modules 66 67 ``Other API Documentation`` 68 ########################### 69 70 .. image:: ../docs/icons/c++.png 71 :target: http://iotdk.intel.com/docs/master/upm 72 .. image:: ../docs/icons/java.png 73 :target: http://iotdk.intel.com/docs/master/upm/java 74 .. image:: ../docs/icons/python.png 75 :target: http://iotdk.intel.com/docs/master/upm/python 76 .. image:: ../docs/icons/node.png 77 :target: http://iotdk.intel.com/docs/master/upm/node 78 79 ``Version Changelog`` 80 ##################### 81 82 For our Version Changelog, please see `here <https://github.com/intel-iot-devkit/upm/blob/master/docs/changelog.md>`_. 83 84 ``Known Limitations`` 85 ################################### 86 87 For the List of Known Limitations, please see `here <https://github.com/intel-iot-devkit/upm/blob/master/docs/knownlimitations.md>`_. 88 89 ``Indices and tables`` 90 ###################### 91 92 * :ref:`genindex` 93 * :ref:`modindex` 94 * :ref:`search` 95
