Merge pull request #24 from LLNL/feature/zagaris2/slic-user-guide

Slic User Guide

src/axom/mainpage.md

@@ -12,7 +12,7 @@ Axom provides libraries that address common computer science needs.  It grew fro
 * @subpage questtop provides an API to query point distance and position relative to meshes.
 * @subpage sidretop provides a data store with hierarchical structure.
 * @subpage slamtop provides an API to construct and process meshes.
-* @subpage slictop provides logging levels and targets.
+* @subpage slictop provides infrastructure for logging application messages.
 
 Dependencies between components are as follows:
 - Core has no dependencies, and the other modules depend on Core

src/axom/slic/CMakeLists.txt

@@ -57,44 +57,41 @@ endif()
 ################################
 # Make/Install the library
 ################################
-set(slic_depends_on core)
+set(slic_depends core)
 
-if (AXOM_ENABLE_LUMBERJACK)
-    list(APPEND slic_depends_on lumberjack mpi)
-endif()
-
-if (WIN32)
-    list(APPEND slic_depends_on dbghelp)  
-endif()
+blt_list_append( TO slic_depends ELEMENTS lumberjack IF ${AXOM_ENABLE_LUMBERJACK} )
+blt_list_append( TO slic_depends ELEMENTS mpi IF ${ENABLE_MPI} )
+blt_list_append( TO slic_depends ELEMENTS dbghelp IF ${WIN32} )
 
 blt_add_library(NAME        slic
                 SOURCES     ${slic_sources}
                 HEADERS     ${slic_headers}
-                DEPENDS_ON  ${slic_depends_on}
+                DEPENDS_ON  ${slic_depends}
                 FOLDER      axom/slic
                 OBJECT      TRUE
                 )
 
-axom_write_unified_header(NAME    slic
-                          HEADERS ${slic_headers})
+axom_write_unified_header( NAME slic
+                           HEADERS ${slic_headers}
+                           )
 
-axom_install_component(NAME    slic
-                       HEADERS ${slic_headers}
-                       )
+axom_install_component( NAME    slic
+                        HEADERS ${slic_headers}
+                        )
 
 
 ################################
 # Add examples
 ################################
 if (AXOM_ENABLE_EXAMPLES)
-    add_subdirectory(examples)
+  add_subdirectory(examples)
 endif()
 
 ################################
 # Add tests
 ################################
 if (AXOM_ENABLE_TESTS)
-    add_subdirectory(tests)
+  add_subdirectory(tests)
 endif()
 
 ################################

src/axom/slic/README.md

@@ -1,6 +1,7 @@
-Slic: Logging priority and target specification {#slictop}
-========
+Slic: Simple Logging Interface Code {#slictop}
+===============================================
 
-[Slic](@ref axom::slic) allows a user to log events at varying priorities.  Log events can be directed to multiple targets based on priority and optional source tags.
+[Slic](@ref axom::slic) provides a *light-wieght*, *modular* and *extensible* 
+logging infrastructure that simplifies logging application messages.
 
-Also see the [Slic user guide](../../../sphinx/axom_docs/html/axom/slic/docs/sphinx/index.html).
+Also see the [Slic user guide](https://axom.readthedocs.io/en/develop/axom/slic/docs/sphinx/index.html#).

src/axom/slic/docs/sphinx/CMakeLists.txt

@@ -0,0 +1,18 @@
+#------------------------------------------------------------------------------
+# Copyright (c) 2017-2019, Lawrence Livermore National Security, LLC and
+# other Axom Project Developers. See the top-level COPYRIGHT file for details.
+#
+# SPDX-License-Identifier: (BSD-3-Clause)
+#------------------------------------------------------------------------------
+
+################################
+# documentation targets
+################################
+
+# add a target to generate documentation with Sphinx
+
+blt_add_sphinx_target( slic_docs )
+
+if (DOXYGEN_FOUND)
+  add_dependencies(slic_docs doxygen_docs)
+endif()

src/axom/slic/docs/sphinx/index.rst

@@ -3,7 +3,19 @@
 .. ##
 .. ## SPDX-License-Identifier: (BSD-3-Clause)
 
-Slic User Documentation
-=======================
+================
+Slic User Guide
+================
 
-Slic provides a lightweight logging facility.
+.. include:: sections/synopsis.rst
+
+.. toctree::
+   :maxdepth: 3
+   :hidden:
+
+   sections/getting_started.rst
+   sections/architecture.rst
+   sections/wrapping_slic_in_macros.rst
+   sections/appendix.rst
+
+.. include:: sections/citations.rst