Merge pull request #101 from NervanaSystems/aprocter/doxygen

Add Doxygen support

CMakeLists.txt

@@ -59,3 +59,5 @@ add_subdirectory(src)
 
 add_subdirectory(test)
 
+add_subdirectory(doc)
+

README.md

@@ -18,8 +18,10 @@ TODO
 2. `cd` to the build directory.
 3. Run `cmake`.  For example, `cmake ../`
 4. Run `make -j8`.
-5. Run `make install`
-6. This will install the libngraph.so and the header files to your home directory/ngraph_dist. 
+5. Run `make install`.
+    * This will install `libngraph.so` and the header files to `$HOME/ngraph_dist`.
+6. _(Optional, requires `doxygen`)_ Run `make doc`.
+    * This will build API documentation in the directory `doc` inside the build directory.
 
 # Testing `libngraph`
 

doc/CMakeLists.txt

+find_package(Doxygen)
+
+if (DOXYGEN_FOUND)
+    set(DOXYGEN_IN ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in)
+    set(DOXYGEN_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)
+    configure_file(${DOXYGEN_IN} ${DOXYGEN_OUT} @ONLY)
+    add_custom_target(doc
+        COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYGEN_OUT}
+        WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+        COMMENT "Generating documentation with Doxygen"
+        VERBATIM )
+else (DOXYGEN_FOUND)
+    message("Doxygen not found, cannot build documentation")
+endif (DOXYGEN_FOUND)

doc/Doxyfile.in

+PROJECT_NAME     = "ngraph++"
+PROJECT_BRIEF    = "Nervana graph compiler"
+
+OUTPUT_DIRECTORY = @CMAKE_CURRENT_BINARY_DIR@
+INPUT            = @CMAKE_SOURCE_DIR@/src
+
+RECURSIVE        = YES