rapidsai · BradReesWork · May 12, 2020 · May 12, 2020 · May 12, 2020 · May 12, 2020
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -29,6 +29,7 @@
 - PR #845 Add .clang-format & format all files
 - PR #859 Updated main docs
 - PR #862 Katz Centrality : Auto calculation of alpha parameter if set to none
+- PR #865 Added C++ docs
 
 ## Bug Fixes
 - PR #763 Update RAPIDS conda dependencies to v0.14

@@ -438,3 +438,16 @@ install(TARGETS cugraph LIBRARY
 
 install(DIRECTORY include/
     DESTINATION include/cugraph)
+
+###################################################################################################
+# - make documentation ----------------------------------------------------------------------------
+# requires doxygen and graphviz to be installed
+# from build directory, run make docs_cugraph
+
+# doc targets for cuGraph
+add_custom_command(OUTPUT CUGRAPH_DOXYGEN
+                   WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/doxygen
+                   COMMAND doxygen Doxyfile
+                   VERBATIM)
+
+add_custom_target(docs_cugraph DEPENDS CUGRAPH_DOXYGEN)
@@ -0,0 +1,3 @@
+# libcugraph
+
+libcugraph is a C++ GPU Accelerated Graph Algorithm library.  
diff --git a/docs/README.md b/docs/README.md
@@ -1,7 +1,7 @@
 # Building Documentation
 
 A basic python environment with packages listed in `./requirement.txt` is
-enough to build the docs.
+enough to build the docs.  Doc generation does not get run by default
 
 ## Get additional dependency
 
@@ -17,3 +17,16 @@ make html
 
 Outputs to `build/html/index.html`
 
+## View docs web page by opening HTML in browser:
+
+First navigate to `/build/html/` folder, i.e., `cd build/html` and then run the following command:
+
+```bash
+python -m http.server
+```
+Then, navigate a web browser to the IP address or hostname of the host machine at port 8000:
+
+```
+https://<host IP-Address>:8000
+```
+Now you can check if your docs edits formatted correctly, and read well.
diff --git a/docs/source/api.rst b/docs/source/api.rst
@@ -39,20 +39,21 @@ Conversion from Other Formats
 Centrality
 ==========
 
-Katz Centrality
----------------
+Betweenness Centrality
+----------------------
 
-.. automodule:: cugraph.centrality.katz_centrality
+.. automodule:: cugraph.centrality.betweenness_centrality
     :members:
     :undoc-members:
 
-Betweenness Centrality
-----------------------
+Katz Centrality
+---------------
 
-.. automodule:: cugraph.centrality.betweenness_centrality
+.. automodule:: cugraph.centrality.katz_centrality
     :members:
     :undoc-members:
 
+
 Community
 =========
 
@@ -91,6 +92,7 @@ Triangle Counting
     :members:
     :undoc-members:
 
+
 Components
 ==========
 
@@ -122,7 +124,7 @@ Core Number
 K-Truss
 -------
 
-.. automodule:: cugraph.ktruss.ktruss_subgraph
+.. automodule:: cugraph.cores.ktruss_subgraph
     :members:
     :undoc-members:
 

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -57,7 +57,7 @@
 
 # General information about the project.
 project = 'cugraph'
-copyright = '2019, NVIDIA'
+copyright = '2019-2020, NVIDIA'
 author = 'NVIDIA'
 
 # The version info for the project you're documenting, acts as replacement for

diff --git a/docs/source/dask-cugraph.rst → docs/source/dask-cugraph.rst.tmp b/docs/source/dask-cugraph.rst → docs/source/dask-cugraph.rst.tmp
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# libcugraph

		libcugraph is a C++ GPU Accelerated Graph Algorithm library.