mirror of
https://github.com/eclipse/upm.git
synced 2025-03-15 04:57:30 +03:00
abb9c91320
This reverts commit a03d0c7e956a931886f99cc180b1d3d8d08f1857. Fix can be implemented easier in cmake configuration instead.
82 lines
2.8 KiB
ReStructuredText
82 lines
2.8 KiB
ReStructuredText
.. 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>`_.
|
|
|
|
``Examples``
|
|
############
|
|
|
|
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>`_
|
|
repository.
|
|
|
|
Individual sensor usage examples for python are available `here <https://github.com/intel-iot-devkit/upm/tree/master/examples/python>`_.
|
|
|
|
``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
|
|
|
|
``Other API Documentation``
|
|
###########################
|
|
|
|
.. image:: ../docs/icons/c++.png
|
|
:target: http://iotdk.intel.com/docs/master/upm/modules.html
|
|
.. image:: ../docs/icons/python.png
|
|
:target: http://iotdk.intel.com/docs/master/upm/python
|
|
.. image:: ../docs/icons/node.png
|
|
:target: http://iotdk.intel.com/docs/master/upm/node
|
|
|
|
``Version Changelog``
|
|
#####################
|
|
|
|
For our Version Changelog, please see `here <https://github.com/intel-iot-devkit/upm/blob/master/docs/changelog.md>`_.
|
|
|
|
``Known Limitations``
|
|
###################################
|
|
|
|
For the 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`
|