Commit 73704ed0 authored by Adam Procter's avatar Adam Procter

Update README.md to document make doc; remove make doc from default targets; clean up doc CMakeList

parent ffe85534
......@@ -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`
......
......@@ -2,9 +2,9 @@ find_package(Doxygen)
if (DOXYGEN_FOUND)
set(DOXYGEN_IN ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in)
set(DOXYGEN_OUT ${CMAKE_CURRENT_BINARY_DIR}/doc/Doxyfile)
set(DOXYGEN_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)
configure_file(${DOXYGEN_IN} ${DOXYGEN_OUT} @ONLY)
add_custom_target( doc ALL
add_custom_target(doc
COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYGEN_OUT}
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
COMMENT "Generating documentation with Doxygen"
......
......@@ -2,6 +2,6 @@ PROJECT_NAME = "ngraph++"
PROJECT_BRIEF = "Nervana graph compiler"
OUTPUT_DIRECTORY = @CMAKE_CURRENT_BINARY_DIR@
INPUT = @CMAKE_CURRENT_SOURCE_DIR@/../src
INPUT = @CMAKE_SOURCE_DIR@/src
RECURSIVE = YES
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment