alexey.zholtikov/upm
1
0
Fork 0
mirror of https://github.com/eclipse/upm.git synced 2025-03-15 04:57:30 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

sphinx: updated index.rst file

Browse Source 
added content from readme.md into index.rst file.

Signed-off-by: Sisinty Sasmita Patra <sisinty.s.patra@intel.com>
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
sisinty sasmita patra 2015-05-18 09:27:00 -07:00 committed by Mihai Tudor Panu
parent 062a7cb826
commit 89c9239798
1 changed files with 44 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
doxy/index.rst
View File

@ -1,36 +1,67 @@
.. UPM Python documentation master file, created by
.. 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!
**Welcome to UPM Python documentation!**
=========================================
.. include:: ../../README.md
:start-after: ==============
:end-before: ### Example
.. include:: ../../README.md
:start-after: configure your project.
:end-before: C/C++ API
``Building UPM``
################
List of available sensors drivers:
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
Limitations and List of Changes
==================
``C/C++ API Documentation``
###########################
This is the Sphinx generated documentation for UPM...
The C/C++ API documentation is available `here <http://iotdk.intel.com/docs/master/upm/>`_.
.. include:: ../../docs/knownlimitations.md
.. include:: ../../docs/changelog.md
``Version``
###########
Indices and tables
==================
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`