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: small changes to index and added link to node documentation

Browse Source 
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
Mihai Tudor Panu 2015-06-03 09:32:05 -07:00
parent 9fb0ca3466
commit 6740932c47
1 changed files with 13 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
doxy/index.rst
View File

@ -3,7 +3,7 @@
You can adapt this file completely to your liking, but it should at least You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive. contain the root `toctree` directive.
**Welcome to UPM Python documentation!** **Welcome to UPM Python Documentation!**
========================================= =========================================
.. include:: ../../README.md .. include:: ../../README.md
@ -14,7 +14,7 @@
################ ################
For building UPM, please follow this `link <https://github.com/intel-iot-devkit/upm/blob/master/docs/building.md>`_. For building UPM, please follow this `link <https://github.com/intel-iot-devkit/upm/blob/master/docs/building.md>`_.
``Making your own UPM Module`` ``Making your own UPM Module``
############################## ##############################
@ -22,7 +22,7 @@ This `link <https://github.com/intel-iot-devkit/upm/blob/master/docs/porting.md
There is also an example available for max31855 `sensor <https://github.com/intel-iot-devkit/upm/blob/master/docs/max31855.md>`_. 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`` ``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>`_. Before you begin development, please take a look at our naming `conventions <https://github.com/intel-iot-devkit/upm/blob/master/docs/naming.md>`_.
@ -33,11 +33,11 @@ Don't forget to check the documentation `section <https://github.com/intel-iot-d
.. note:: .. note::
* Make sure you add yourself as an author on every new code file submitted. * 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. * If you are providing a fix with significant changes, feel free to add yourself as a contributor.
* Signing-off your commits is mandatory. * Signing-off your commits is mandatory.
``List of available sensors drivers`` ``List of Available Sensors Drivers``
###################################### ######################################
.. toctree:: .. toctree::
@ -45,20 +45,21 @@ Don't forget to check the documentation `section <https://github.com/intel-iot-d
modules modules
``C/C++ API Documentation`` ``Other API Documentation``
########################### ###########################
The C/C++ API documentation is available `here <http://iotdk.intel.com/docs/master/upm/>`_. The C/C++ API documentation is available `here <http://iotdk.intel.com/docs/master/upm/>`_.
The Node.JS API documentation is available `here <http://iotdk.intel.com/docs/master/upm/node>`_.
``Version`` ``Version Changelog``
########### #####################
For Version Changelog, please see `here <https://github.com/intel-iot-devkit/upm/blob/master/docs/changelog.md>`_. For our Version Changelog, please see `here <https://github.com/intel-iot-devkit/upm/blob/master/docs/changelog.md>`_.
``Limitations and List of Changes`` ``Known Limitations``
################################### ###################################
For List of Known Limitations, please see `here <https://github.com/intel-iot-devkit/upm/blob/master/docs/knownlimitations.md>`_. For the List of Known Limitations, please see `here <https://github.com/intel-iot-devkit/upm/blob/master/docs/knownlimitations.md>`_.
``Indices and tables`` ``Indices and tables``
###################### ######################