docs: updated links to documentation pages from readme.md and for porting example

Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
Mihai Tudor Panu 2015-06-03 10:33:46 -07:00
parent 5733918a2f
commit e0bc9573d4
6 changed files with 12 additions and 3 deletions

View File

@ -65,6 +65,9 @@ if (BUILDDOC)
find_package (Doxygen) find_package (Doxygen)
if (DOXYGEN_FOUND) if (DOXYGEN_FOUND)
configure_file (${CMAKE_CURRENT_SOURCE_DIR}/doxy/Doxyfile.in ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY) configure_file (${CMAKE_CURRENT_SOURCE_DIR}/doxy/Doxyfile.in ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY)
configure_file (${CMAKE_CURRENT_SOURCE_DIR}/docs/c++.png ${CMAKE_CURRENT_BINARY_DIR}/html/docs/c++.png COPYONLY)
configure_file (${CMAKE_CURRENT_SOURCE_DIR}/docs/python.png ${CMAKE_CURRENT_BINARY_DIR}/html/docs/python.png COPYONLY)
configure_file (${CMAKE_CURRENT_SOURCE_DIR}/docs/node.png ${CMAKE_CURRENT_BINARY_DIR}/html/docs/node.png COPYONLY)
add_custom_target (doc add_custom_target (doc
${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}

View File

@ -57,10 +57,16 @@ 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 If you are providing a fix with significant changes, feel free to add yourself
as a contributor. Signing-off your commits is mandatory. as a contributor. Signing-off your commits is mandatory.
C/C++ API Documentation API Documentation
============== ==============
The C/C++ documentation is available [here](http://iotdk.intel.com/docs/master/upm/). @htmlonly
<a href="http://iotdk.intel.com/docs/master/upm/"><img src="docs/c++.png"/></a>
<a href="http://iotdk.intel.com/docs/master/upm/python"><img src="docs/python.png"/></a>
<a href="http://iotdk.intel.com/docs/master/upm/node"><img src="docs/node.png"/></a>
@endhtmlonly
Version @ref changelog [here](docs/changelog.md). Version @ref changelog [here](docs/changelog.md).

BIN
docs/c++.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.8 KiB

View File

@ -80,7 +80,7 @@ useful to us and converting it to a double.
Our final example, very easy to use API! Our final example, very easy to use API!
@snippet examples/max31855.cxx Interesting @snippet examples/c++/max31855.cxx Interesting
### Building ### Building

BIN
docs/node.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.0 KiB

BIN
docs/python.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.5 KiB