Much Anticipated Camp Docs

.readthedocs.yml

@@ -0,0 +1,42 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+  apt_packages:
+    - ghostscript
+    - texlive-full
+
+##
+## Code for debugging directory structure in readthedocs 
+## to fix broken links, etc.
+##
+# Print tree
+#build:
+#  os: ubuntu-20.04
+#  apt_packages:
+#    - tree
+#  tools:
+#    python: "3.7"
+#  jobs:
+#    post_build:
+#      - tree -J
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# Optionally build docs in add'l formats such as PDF and ePub
+#formats: all
+
+# Set requirements needed to build the docs
+python:
+  install:
+    - requirements: docs/requirements.txt

CMakeLists.txt

@@ -39,6 +39,7 @@ set(CMAKE_CXX_EXTENSIONS OFF)
 include(cmake/load_blt.cmake)
 
 
+cmake_dependent_option(CAMP_ENABLE_DOCUMENTATION "Build Docs" Off "ENABLE_DOCS" Off)
 cmake_dependent_option(CAMP_ENABLE_TESTS "Build tests" On "ENABLE_TESTS" Off)
 
 # if ENABLE_TESTS is defined by a parent project, and
@@ -190,3 +191,7 @@ if(CAMP_ENABLE_TESTS)
   add_subdirectory(test)
 endif()
 
+if(CAMP_ENABLE_DOCUMENTATION)
+  add_subdirectory(docs)
+endif()
+

README.md

@@ -1,5 +1,13 @@
+# <img src="/share/raja/logo/camp2-gradient.png" width="128" valign="middle" alt="Camp"/>
+
 ## CAMP Concepts And Meta-Programming library
 
-This project collects a variety of macros and metaprogramming facilities for C++
-projects.  It's in the direction of projects like metal (a major influence) but
-with a focus on wide compiler compatibility across HPC-oriented systems.
+CAMP is a C++ Meta-Programming library which provides HPC compiler compatability
+and portability abstractions. This project is a collection of various macros and 
+metaprogramming facilities and is part of the RAJA Portability Suite. 
+With projects like METAL as a major influence, CAMP focuses on wide compiler 
+compatibility across HPC-oriented systems.
+
+See Documentation on ReadTheDocs, including User and Contributor Guides.
+
+If you have questions, email [email protected].

cmake/FindSphinx.cmake

@@ -0,0 +1,17 @@
+###############################################################################
+# Copyright (c) 2016-24, Lawrence Livermore National Security, LLC
+# and other RAJA project contributors. See the RAJA/LICENSE file for details.
+#
+# SPDX-License-Identifier: (BSD-3-Clause)
+###############################################################################
+
+find_program(SPHINX_EXECUTABLE
+        NAMES sphinx-build sphinx-build2
+        DOC "Path to sphinx-build executable")
+
+# Handle REQUIRED and QUIET arguments
+# this will also set SPHINX_FOUND to true if SPHINX_EXECUTABLE exists
+include(FindPackageHandleStandardArgs)
+find_package_handle_standard_args(Sphinx
+        "Failed to locate sphinx-build executable"
+        SPHINX_EXECUTABLE)

docs/CMakeLists.txt

@@ -0,0 +1,25 @@
+###############################################################################
+# Copyright (c) 2016-18, Lawrence Livermore National Security, LLC.
+# Produced at the Lawrence Livermore National Laboratory
+# Maintained by Tom Scogland <[email protected]>
+# CODE-756261, All rights reserved.
+# This file is part of camp.
+# For details about use and distribution, please read LICENSE and NOTICE from
+# http://github.com/llnl/camp
+###############################################################################
+
+if (CAMP_ENABLE_DOCUMENTATION)
+  if (SPHINX_FOUND)
+    message(STATUS "Found Sphinx")
+    blt_add_sphinx_target( camp_docs )
+  endif()
+
+  if (DOXYGEN_FOUND)
+    add_subdirectory(doxygen)
+  endif()
+
+  if ( NOT SPHINX_FOUND AND NOT DOXGEN_FOUND)
+    message(WARNING "CAMP_ENABLE_DOCUMENTATION=On, but Sphinx or Doxygen not found. \
+      Documentation won't be built.")
+  endif ()
+endif()