From 6efe6916ba731d0113f1ba34c6a4ebbd7c142a3e Mon Sep 17 00:00:00 2001 From: Mihai Tudor Panu Date: Thu, 4 Jun 2015 15:16:25 -0700 Subject: [PATCH] docs: modified index pages for documentation to link to samples repo Signed-off-by: Mihai Tudor Panu --- README.md | 3 + doxy/index.rst | 8 + .../yuidoc/tmpl/partials/index.handlebars | 286 +++++++++--------- 3 files changed, 162 insertions(+), 135 deletions(-) diff --git a/README.md b/README.md index 76acd9fb..99b3094d 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,9 @@ may also create more complex structures in order to interface with them. Browse through the list of all [examples](https://github.com/intel-iot-devkit/upm/tree/master/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. + ### Supported Sensors Supported [sensor list](http://iotdk.intel.com/docs/master/upm/modules.html) from API documentation. diff --git a/doxy/index.rst b/doxy/index.rst index c8307be1..caf9e6d9 100644 --- a/doxy/index.rst +++ b/doxy/index.rst @@ -15,6 +15,14 @@ For building UPM, please follow this `link `_. +``Examples`` +############ + +Multi-sensor samples for the starter and specialized kits can be found in the `iot-devkit-samples `_ +repository. + +Individual sensor usage examples for python are available `here `_. + ``Making your own UPM Module`` ############################## diff --git a/doxy/node/generators/yuidoc/tmpl/partials/index.handlebars b/doxy/node/generators/yuidoc/tmpl/partials/index.handlebars index e0eacbcd..97b21c59 100644 --- a/doxy/node/generators/yuidoc/tmpl/partials/index.handlebars +++ b/doxy/node/generators/yuidoc/tmpl/partials/index.handlebars @@ -1,150 +1,166 @@
-
-

Welcome to UPM Node.JS Documentation!

+
+

Welcome to UPM Node.JS Documentation!

+ + +

Browse to a module or class using the sidebar to view its API + documentation.

+ +

UPM is a high level repository for sensors that use libmraa. Each + sensor links to libmraa and are not meant to be interlinked although + some groups of sensors may be. Each sensor contains a header which + allows to interface with it. Typically a sensor is represented as a + class and instantiated.

+ +

The constructor is expected to initialise the sensor and parameters + may be used to provide identification/pin location on the board.

+ +

Typically an update() function will be called in order to get new + data from the sensor in order to reduce load when doing multiple reads + to sensor data.

+
+

Examples*

-

Browse to a module or class using the sidebar to view its API - documentation.

+

Multi-sensor samples for the starter and specialized kits can be + found in the + iot-devkit-samples + repository.

-

UPM is a high level repository for sensors that use libmraa. Each - sensor links to libmraa and are not meant to be interlinked although - some groups of sensors may be. Each sensor contains a header which - allows to interface with it. Typically a sensor is represented as a - class and instantiated.

+

Individual sensor usage examples for node.js are available + here.

+ +
+
+

Building + UPM*

+ -

The constructor is expected to initialise the sensor and - parameters may be used to provide identification/pin location on the - board.

+

For building UPM, please follow this + link.

+ +
+
+

Making + your own + UPM Module*

+ -

Typically an update() function will be called in order to get new - data from the sensor in order to reduce load when doing multiple - reads to sensor data.

-
-

Building - UPM*

- +

This + link + has more information on making a new UPM module.

-

For building UPM, please follow this - link.

- +

There is also an example available for max31855 + sensor.

+ +
+
+

Naming + Conventions and + Rules for + New UPM + Contributions*

+ + +

Before you begin development, please take a look at our naming + conventions.

+ + +

Also, please read the guidelines for contributions to + UPM.

+ + +

Don’t forget to check the documentation + section.

+ +
+ +

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.
    • +
-
-

Making - your own - UPM Module*

- +
+
+

API Documentation

+ -

This - link - has more information on making a new UPM module.

+

+ + +

+
+
+

Version + Changelog*

+ -

There is also an example available for max31855 - sensor.

- -
-
-

Naming - Conventions and - Rules for - New UPM - Contributions*

- +

For our Version Changelog, please see + here.

+ +
+
+

Known + Limitations*

+ -

Before you begin development, please take a look at our naming - conventions.

- +

For the List of Known Limitations, please see + here.

+ +
+
+

Keyboard + Shortcuts*

+ +
    +
  • -

    Also, please read the guidelines for contributions to - UPM.

    - +

    Press s to focus the API search box.

    • +
  • -

    Don’t forget to check the documentation - section.

    - -
    +

    Use Up and Down to select classes, + modules, and search results.

    • +
  • -

    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.
      • -
    -
-
-
-

API Documentation

- +

With the API search box or sidebar focused, use ⌘-Left + or ⌘-Right to switch + sidebar tabs.

+
  • -

    - - -

    -
    • -
    -

    Version - Changelog*

    - - -

    For our Version Changelog, please see - here.

    - -
    -
    -

    Known - Limitations*

    - - -

    For the List of Known Limitations, please see - here.

    - -
    -
    -

    Keyboard - Shortcuts*

    - -
      -
    • - -

      Press s to focus the API search box.

      • -
    • - -

      Use Up and Down to select classes, - modules, and search results.

      • -
    • - -

      With the API search box or sidebar focused, use ⌘-Left - or ⌘-Right to switch - sidebar tabs.

      • -
    • - -

      With the API search box or sidebar focused, use Ctrl+Left - and Ctrl+Right to switch sidebar tabs.

      • -
    -
    -
    +

    With the API search box or sidebar focused, use Ctrl+Left + and Ctrl+Right to switch sidebar tabs.

    + +
    +