Update broken CMake due to FORD changes

 - Still dynamically and efficiently compute ford outputs so proper
   dependency checking will prevent unnecessary rebuilds
 - Add some debugging to the travis-ci coverage push
 - fix some broken links in FORD documentation
 - tweak json-module.md so it plays nicer with CMake and ./build.sh
   - Only enable USE_UCS4 macro to FORD if actually building for unicode

Author: zbeekman

.travis.yml

@@ -80,10 +80,14 @@ script:
 
 after_success:
   - cd $TRAVIS_BUILD_DIR
-  - |
-    if [[ $CODE_COVERAGE == [yY]* ]]; then
-      bash <(curl -s https://codecov.io/bash) -f json_fortran.F90.gcov jf_test_*.[fF]90.gcov
-    fi
   - git config --global user.name "TRAVIS-CI-for-$(git --no-pager show -s --format='%cn' $TRAVIS_COMMIT)"
   - git config --global user.email "$(git --no-pager show -s --format='%ce' $TRAVIS_COMMIT)"
 #broken for now#  - ./deploy.sh #handles updating documentation for master branch as well as tags
+  - (yes | rm -r doc gh-pages) || true # wipe out doc dirs to avoid confusing codecov
+  - |
+    if [[ $CODE_COVERAGE == [yY]* ]]; then
+      rm json_module-*unicode.F90.gcov || true
+      mv json_module.F90.gcov src/
+      mv jf_test*.[fF]90.gcov src/tests/
+      bash <(curl -s https://codecov.io/bash) -v -X gcov
+    fi

CMakeLists.txt

@@ -146,36 +146,49 @@ if ( NOT SKIP_DOC_GEN )
   find_program ( FORD ford )
   if ( FORD ) # Found
     file ( COPY "${CMAKE_SOURCE_DIR}/media" DESTINATION "${CMAKE_BINARY_DIR}/" )
+    file ( GLOB_RECURSE PAGES_FILES "${CMAKE_SOURCE_DIR}/pages/*.*")
     set ( DOC_DIR "${CMAKE_BINARY_DIR}/doc" )
+    set ( PAGES_DIR "${CMAKE_SOURCE_DIR}/pages" )
+    set ( PROJ_DIR "${CMAKE_SOURCE_DIR}/src" )
     set ( FORD_PROJECT_FILE "${CMAKE_SOURCE_DIR}/json-fortran.md" )
+    if ( ENABLE_UNICODE )
+      set ( MACRO_FLAG "-m USE_UCS4" )
+    else ()
+      set ( MACRO_FLAG "" )
+    endif ()
     # Dynamically generate the FORD outputs list
     message ( STATUS "Dynamically computing FORD output information..." )
     if ( NOT (DEFINED FORD_OUTPUTS_CACHED) )
       message ( STATUS "Running FORD to dynamically compute documentation outputs, this could take a while..." )
       execute_process ( COMMAND ${CMAKE_COMMAND} -E remove_directory ${DOC_DIR}
 	COMMAND ${CMAKE_COMMAND} -E make_directory ${DOC_DIR}
-	COMMAND "${FORD}" -d "${CMAKE_SOURCE_DIR}/src" -o "${DOC_DIR}" "${FORD_PROJECT_FILE}" OUTPUT_QUIET )
+	COMMAND "${FORD}" -q ${MACRO_FLAG} -d "${PROJ_DIR}" -o "${DOC_DIR}" -p "${PAGE_DIR}" "${FORD_PROJECT_FILE}" OUTPUT_QUIET )
+    else ()
+      message ( STATUS "Re-using cached FORD outputs, rather than regenerating them" )
     endif ()
     file ( GLOB_RECURSE FORD_OUTPUTS
-      "${DOC_DIR}/*.html" )
+      "${DOC_DIR}/*.*" )
     file ( GLOB_RECURSE FORD_CLEAN_OUTPUTS
       "${DOC_DIR}/*.*" )
     if ( (DEFINED FORD_OUTPUTS) AND ( NOT ( "${FORD_OUTPUTS}" STREQUAL "" ) ) )
+      message ( STATUS "Caching FORD outputs" )
       set ( FORD_OUTPUTS_CACHED "${FORD_OUTPUTS}"
-	CACHE INTERNAL "internal variable to attempt to prevent rebuilding FORD docs" FORCE )
+	CACHE STRING "variable containing FORD outputs to prevent rebuilding FORD docs" FORCE )
     endif ()
     message ( STATUS "Done dynamically computing FORD outputs." )
 
-    foreach ( SRC_FILE ${JF_LIB_SRCS} ${JF_TEST_SRCS} )
-      list ( APPEND FORD_DEPENDS "${SRC_FILE}" )
-    endforeach ( SRC_FILE )
+    foreach ( DOC_SRC_FILE ${JF_LIB_SRCS} ${JF_TEST_SRCS} ${CMAKE_SOURCE_DIR}/README.md
+	${CMAKE_SOURCE_DIR}/CHANGELOG.md ${CMAKE_SOURCE_DIR}/CONTRIBUTING.md
+	${CMAKE_SOURCE_DIR}/LICENSE ${CMAKE_SOURCE_DIR}/json-fortran.md ${PAGES_FILES} )
+      list ( APPEND FORD_DEPENDS "${DOC_SRC_FILE}" )
+    endforeach ()
     add_custom_command ( OUTPUT ${FORD_OUTPUTS_CACHED}
-      COMMAND "${FORD}" -d "${CMAKE_SOURCE_DIR}/src" -o "${DOC_DIR}" "${FORD_PROJECT_FILE}"
+      COMMAND "${FORD}" ${MACRO_FLAG} -d "${PROJ_DIR}" -o "${DOC_DIR}" -p "${CMAKE_SOURCE_DIR}/pages" "${FORD_PROJECT_FILE}"
       MAIN_DEPENDENCY "${FORD_PROJECT_FILE}"
       DEPENDS ${FORD_DEPENDS}
       COMMENT "Building HTML documentation for ${CMAKE_PROJECT_NAME} using FORD" )
     add_custom_target ( documentation ALL
-      DEPENDS ${FORD_OUTPUTS} )
+      DEPENDS ${FORD_OUTPUTS_CACHED} )
     set ( INSTALL_API_DOCUMENTATION TRUE
       CACHE BOOL "Install FORD generated documentation?" )
     if ( INSTALL_API_DOCUMENTATION )

build.sh

@@ -64,7 +64,8 @@
 set -e
 
 FORDMD='json-fortran.md'        # FORD options file for building documentation
-DOCDIR='./documentation/'       # build directory for documentation
+DOCDIR='./doc/'                 # build directory for documentation
+PAGESDIR='./pages/'             # Directory for FORD "pages"
 SRCDIR='./src/'                 # library source directory
 TESTDIR='./src/tests/'          # unit test source directory
 INTROSPECDIR='./src/tests/introspection/' # pre compile configuration tests directory
@@ -330,7 +331,8 @@ echo ""
 if [[ $JF_SKIP_DOCS != [yY]* ]]; then
     if hash ford 2>/dev/null; then
 	echo "Building documentation..."
-	ford $FORDMD
+	[[ $TRY_UNICODE = [yY]* ]] && MACRO_FLAG="-m USE_UCS4"
+	ford $MACRO_FLAG -p $PAGESDIR $FORDMD
     else
 	echo "FORD not found! Install using: sudo pip install ford"
     fi

json-fortran.md

@@ -1,8 +1,6 @@
-page_dir: pages
 project: json-fortran
 favicon: ./media/json-fortran-32x32.png
 project_dir: ./src
-macro: USE_UCS4
 output_dir: ./doc
 media_dir: ./media
 project_github: https://github.com/jacobwilliams/json-fortran
@@ -39,7 +37,7 @@ The json-fortran source code and related files and documentation are distributed
 # Offficial Releases
 
 Browse the documentation for a particular release
-[here](|url|releases/index.html) or download the latest official
+[here](|url|/page/releases/index.html) or download the latest official
 release
 [here](https://github.com/jacobwilliams/json-fortran/releases/tag/4.1.1).
 

pages/development-resources/json_module.F90.gcov.md

@@ -10,7 +10,7 @@ title: Coverage Analysis
 The following report was automatically generated from
 [gcov](https://gcc.gnu.org/onlinedocs/gcc/Gcov.html) output by the
 [FoBiS.py](https://github.com/szaghi/FoBiS) Fortran build
-tool. [gccr.pl](|url|page/development-resources/gccr.pl) was used to
+tool. [gccr.pl](|url|/page/development-resources/gccr.pl) was used to
 merge [gcov](https://gcc.gnu.org/onlinedocs/gcc/Gcov.html) coverage
 reports, and can be obtained at <https://github.com/eel3/gccr>. If
 procedure coverage is at 100%, also have a look at the

pages/releases/index.md

@@ -5,7 +5,9 @@ title: Official Releases
 # Official Releases
 
 This is where to find the documentation corresponding to an official,
-tagged release.
+tagged release. If you are looking for the most current documentation
+of the `master` branch, please head back to the
+[main page](|url|/index.html).
 
 ## Latest Stable Release
 
@@ -19,7 +21,7 @@ tagged release.
 **Note:** There is currently no way to navigate back to the general/master
 documentation from the documentation for official releases other than
 using the browser's back button. Feel free to bookmark this page, or
-the [main project page](|url|index.html) for convenient navigation.
+the [main project page](|url|/index.html) for convenient navigation.
 
 * [4.1.1](http://jacobwilliams.github.io/json-fortran/4.1.1/json_module_F90.html)
    ([ROBODoc](https://github.com/gumpu/ROBODoc) generated documentation)