mirror of
https://github.com/eclipse/upm.git
synced 2025-03-14 20:47:30 +03:00
sphinx: small changes to index and added link to node documentation
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
parent
9fb0ca3466
commit
6740932c47
@ -3,7 +3,7 @@
|
||||
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
|
||||
@ -14,7 +14,7 @@
|
||||
################
|
||||
|
||||
For building UPM, please follow this `link <https://github.com/intel-iot-devkit/upm/blob/master/docs/building.md>`_.
|
||||
|
||||
|
||||
``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>`_.
|
||||
|
||||
``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>`_.
|
||||
@ -33,11 +33,11 @@ Don't forget to check the documentation `section <https://github.com/intel-iot-d
|
||||
|
||||
.. 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.
|
||||
* 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``
|
||||
``List of Available Sensors Drivers``
|
||||
######################################
|
||||
|
||||
.. toctree::
|
||||
@ -45,20 +45,21 @@ Don't forget to check the documentation `section <https://github.com/intel-iot-d
|
||||
|
||||
modules
|
||||
|
||||
``C/C++ API Documentation``
|
||||
``Other API Documentation``
|
||||
###########################
|
||||
|
||||
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``
|
||||
######################
|
||||
|
Loading…
x
Reference in New Issue
Block a user