Merge pull request #69 from jacobwilliams/robodoc-tests

moved generic robodoc options into .rc file.  updated scons file for the...

Author: jacobwilliams

CMakeLists.txt

@@ -114,12 +114,11 @@ set ( SKIP_DOC_GEN FALSE CACHE BOOL
 if ( NOT SKIP_DOC_GEN )
   find_program ( ROBODOC robodoc )
   if ( ROBODOC ) # Found
-    set ( ROBODOC_OPTIONS --rc ${CMAKE_SOURCE_DIR}/robodoc.rc --tabsize 4 --index --toc --sections --syntaxcolors --source_line_numbers
+    set ( ROBODOC_OPTIONS --rc ${CMAKE_SOURCE_DIR}/robodoc.rc
       CACHE STRING "Options passed to robodoc to control building the documentation" )
     set ( DOC_DIR "${CMAKE_BINARY_DIR}/documentation" )
     set ( REQUIRED_ROBODOC_OPTIONS
       --src "${CMAKE_SOURCE_DIR}/src" --doc "${DOC_DIR}"
-      --multidoc --html --ignore_case_when_linking
       --documenttitle "${CMAKE_PROJECT_NAME}" )
     # Dynamically generate the ROBODoc outputs list
     message ( STATUS "Dynamically computing ROBODoc output information..." )

SConstruct

@@ -99,18 +99,10 @@ env.Alias('install', libinstall)
 
 if find_executable('robodoc'):
 
-    docfiles = [join('documentation','json_module_f90.html'),
-                join('documentation','masterindex.html'),
-                join('documentation','robo_classes.html'),
-                join('documentation','robo_definitions.html'),
-                join('documentation','robo_functions.html'),
-                join('documentation','robo_modules.html'),
-                join('documentation','robo_sourcefiles.html'),
-                join('documentation','robodoc.css'),
-                join('documentation','toc_index.html'), ]
-
-    bld = Builder(action='robodoc --rc robodoc.rc --src src/ --doc documentation/ --multidoc --html'+
-                  ' --ignore_case_when_linking --syntaxcolors --source_line_numbers --index --tabsize 4 --documenttitle jsonfortran --sections')
+    docfiles = glob.glob('documentation/*.*')   #main directory
+    docfiles.append(glob.glob('documentation/tests/*.*')) #tests directory
+
+    bld = Builder(action='robodoc --rc robodoc.rc --src src/ --doc documentation/ --documenttitle jsonfortran')
     env = Environment(BUILDERS = {'RoboDoc' : bld})
     env.RoboDoc(docfiles, src)
     env.Depends(docfiles, src)

build.sh

@@ -70,7 +70,7 @@ fi
 #build the documentation with RoboDoc:
 echo ""
 echo "Building documentation..."
-robodoc --rc ./robodoc.rc --src ${SRCDIR} --doc ${DOCDIR} --multidoc --html --ignore_case_when_linking --syntaxcolors --source_line_numbers --index --tabsize 4 --documenttitle ${PROJECTNAME} --sections
+robodoc --rc ./robodoc.rc --src ${SRCDIR} --doc ${DOCDIR} --documenttitle ${PROJECTNAME}
 echo ""
 
 # Run all the tests unless $JF_SKIP_TESTS

robodoc.rc

@@ -10,7 +10,7 @@
 #    Jacob Williams, 12/6/2014
 #
 #  HISTORY
-#    Updated 1/6/2014
+#    Updated 1/6/2014, 2/28/2025
 #
 
 items:
@@ -41,6 +41,15 @@ headertypes:
     d  "Parameters"       robo_definitions 3
     c  "Classes"          robo_classes     2
     I  "Interfaces"       robo_interfaces  1
+options:
+    --multidoc
+    --html
+    --ignore_case_when_linking
+    --syntaxcolors
+    --source_line_numbers
+    --index 
+    --tabsize 4
+    --sections
 keywords:
     abstract
     allocatable