Browse Source

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

Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
Mihai Tudor Panu 9 years ago
parent
commit
e0bc9573d4
6 changed files with 12 additions and 3 deletions
  1. 3
    0
      CMakeLists.txt
  2. 8
    2
      README.md
  3. BIN
      docs/c++.png
  4. 1
    1
      docs/max31855.md
  5. BIN
      docs/node.png
  6. BIN
      docs/python.png

+ 3
- 0
CMakeLists.txt View File

65
   find_package (Doxygen)
65
   find_package (Doxygen)
66
   if (DOXYGEN_FOUND)
66
   if (DOXYGEN_FOUND)
67
     configure_file (${CMAKE_CURRENT_SOURCE_DIR}/doxy/Doxyfile.in ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY)
67
     configure_file (${CMAKE_CURRENT_SOURCE_DIR}/doxy/Doxyfile.in ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY)
68
+	configure_file (${CMAKE_CURRENT_SOURCE_DIR}/docs/c++.png ${CMAKE_CURRENT_BINARY_DIR}/html/docs/c++.png COPYONLY)
69
+	configure_file (${CMAKE_CURRENT_SOURCE_DIR}/docs/python.png ${CMAKE_CURRENT_BINARY_DIR}/html/docs/python.png COPYONLY)
70
+	configure_file (${CMAKE_CURRENT_SOURCE_DIR}/docs/node.png ${CMAKE_CURRENT_BINARY_DIR}/html/docs/node.png COPYONLY)
68
     add_custom_target (doc
71
     add_custom_target (doc
69
       ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
72
       ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
70
       WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
73
       WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}

+ 8
- 2
README.md View File

57
 If you are providing a fix with significant changes, feel free to add yourself
57
 If you are providing a fix with significant changes, feel free to add yourself
58
 as a contributor. Signing-off your commits is mandatory.
58
 as a contributor. Signing-off your commits is mandatory.
59
 
59
 
60
-C/C++ API Documentation
60
+API Documentation
61
 ==============
61
 ==============
62
 
62
 
63
-The C/C++ documentation is available [here](http://iotdk.intel.com/docs/master/upm/).
63
+@htmlonly
64
+
65
+<a href="http://iotdk.intel.com/docs/master/upm/"><img src="docs/c++.png"/></a>
66
+<a href="http://iotdk.intel.com/docs/master/upm/python"><img src="docs/python.png"/></a>
67
+<a href="http://iotdk.intel.com/docs/master/upm/node"><img src="docs/node.png"/></a>
68
+
69
+@endhtmlonly
64
 
70
 
65
 Version @ref changelog [here](docs/changelog.md).
71
 Version @ref changelog [here](docs/changelog.md).
66
 
72
 

BIN
docs/c++.png View File


+ 1
- 1
docs/max31855.md View File

80
 
80
 
81
 Our final example, very easy to use API!
81
 Our final example, very easy to use API!
82
 
82
 
83
-@snippet examples/max31855.cxx Interesting
83
+@snippet examples/c++/max31855.cxx Interesting
84
 
84
 
85
 ### Building
85
 ### Building
86
 
86
 

BIN
docs/node.png View File


BIN
docs/python.png View File