Doxygen (#44)

* adding doxygen-sphinx documentation

---------

Co-authored-by: Ryan Danehy <[email protected]>
Co-authored-by: pelesh <[email protected]>

.github/workflows/documentation.yml

@@ -0,0 +1,27 @@
+name: documentation
+
+on: [pull_request]
+
+permissions:
+  contents: write
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Doxygen Build
+        uses: ryandanehy/sphinx-doxygen@v1
+        with:
+           sphinx-path: './sphinx/_build'
+           working-directory: 'docs'
+           doxyfile-path: './doxygen/Doxyfile.in'
+      - uses: actions/setup-python@v3
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        if: ${{ github.event_name == 'pull_request' }}
+        with:
+          publish_branch: gh-pages
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs/sphinx/_build/
+          force_orphan: true

.gitignore

@@ -1,5 +1,6 @@
 .vscode/
 build/*
+_build
 install/*
 *~
 *.swp

.gitmodules

@@ -1,3 +1,6 @@
 [submodule "buildsystem/spack/spack"]
 	path = buildsystem/spack/spack
 	url = https://github.com/cameronrutherford/spack.git
+[submodule "doxygen-awesome-css"]
+	path = docs/doxygen-awesome-css
+	url = https://github.com/jothepro/doxygen-awesome-css.git

CMakeLists.txt

@@ -29,6 +29,9 @@ option(RESOLVE_USE_HIP  "Use HIP language and ROCm library" OFF)
 option(RESOLVE_USE_GPU  "Use GPU device for computations" OFF)
 mark_as_advanced(FORCE RESOLVE_USE_GPU)
 
+option(RESOLVE_USE_DOXYGEN "Use Doxygen to generate Re::Solve documentation" ON)
+set(RESOLVE_CTEST_OUTPUT_DIR ${PROJECT_BINARY_DIR} CACHE PATH "Directory where CTest outputs are saved")
+
 if(RESOLVE_USE_CUDA)
   set(RESOLVE_USE_GPU ON CACHE BOOL "Using CUDA GPU!" FORCE)
 endif()
@@ -48,6 +51,48 @@ set(CMAKE_INSTALL_RPATH ${CMAKE_INSTALL_PREFIX}/lib)
 # Add CMake sources from `cmake` dir
 list(APPEND CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake)
 
+# Including clang-format cmake files to do automatic checking of formating
+# TODO: Set up clang-format
+#include(./cmake/clang-format)
+
+if (RESOLVE_USE_DOXYGEN)
+  find_package(Doxygen)
+endif()
+
+if ( DOXYGEN_FOUND )
+  set( DOXYGEN_OUTPUT_DIRECTORY ./sphinx/_build/doxygen )
+  set( DOXYGEN_COLLABORATION_GRAPH YES )
+  set( DOXYGEN_EXTRACT_ALL YES )
+  set( DOXYGEN_CLASS_DIAGRAMS YES )
+  set( DOXYGEN_HIDE_UNDOC_RELATIONS NO )
+  set( DOXYGEN_HAVE_DOT YES )
+  set( DOXYGEN_CLASS_GRAPH YES )
+  set( DOXYGEN_CALL_GRAPH YES )
+  set( DOXYGEN_CALLER_GRAPH YES )
+  set( DOXYGEN_COLLABORATION_GRAPH YES )
+  set( DOXYGEN_BUILTIN_STL_SUPPORT YES )
+  set( DOXYGEN_EXTRACT_PRIVATE YES )
+  set( DOXYGEN_EXTRACT_PACKAGE YES )
+  set( DOXYGEN_EXTRACT_STATIC YES )
+  set( DOXYGEN_EXTRACT_LOCALMETHODS YES )
+  set( DOXYGEN_UML_LOOK YES )
+  set( DOXYGEN_UML_LIMIT_NUM_FIELDS 50 )
+  set( DOXYGEN_TEMPLATE_RELATIONS YES )
+  set( DOXYGEN_DOT_GRAPH_MAX_NODES 100 )
+  set( DOXYGEN_MAX_DOT_GRAPH_DEPTH 0 )
+  set( DOXYGEN_DOT_TRANSPARENT YES )
+  set(DOXYGEN_DISABLE_INDEX NO)
+  set(DOXYGEN_FULL_SIDEBAR NO)
+  set(DOXYGEN_GENERATE_TREEVIEW YES)
+  set(DOXYGEN_HTML_EXTRA_STYLESHEET "./docs/doxygen/doxygen-awesome-css/doxygen-awesome.css")
+  set(DOXYGEN_HTML_COLORSTYLE LIGHT)
+  doxygen_add_docs( doxygen ${RPP_PROJECT_SOURCE_DIR} )
+
+else()
+  message( "Doxygen need to be installed to generate the doxygen documentation" )
+endif()
+
+
 if (RESOLVE_USE_KLU)
   include(FindKLU)
   if(NOT KLU_LIBRARY)

README.md

@@ -2,6 +2,8 @@
 
 ReSolve is a library of GPU-resident linear solver. It contains iterative and direct linear solvers designed to run on NVIDIA and AMD GPUs, as well as on CPU devices.
 
+ReadTheDocs Documentation lives here https://ornl.github.io/ReSolve/
+
 ## Getting started
 
 Dependencies: