Split TribitsDevelopersGuide.* into TribitsUsersGuide.* and TribitsMaintainersGuide.* (#381)

test/core/DependencyUnitTests/CMakeLists.txt

@@ -66,16 +66,16 @@ set(REDUCED_MOCK_TRILINOS_DIR
 
 # Expected output files directory
 set(REDUCED_MOCK_TRILINOS_OUTPUT_DIR
-  "${${PROJECT_NAME}_TRIBITS_DIR}/doc/developers_guide/ReducedMockTrilinosOutput")
+  "${${PROJECT_NAME}_TRIBITS_DIR}/doc/guides/ReducedMockTrilinosOutput")
 
 #
 # NOTE: These tests compare against expected output stored in files under the
-# in the developers_guide/ReducedMockTrilinosOuptut/ directory and are used in
-# the TribitsDevelopersGuide.rst document.  Therefore, if the behavior of
-# TriBITS changes in such a way as to break these tests, then if any of the
-# contents of the files under this directory need to change, then one must
-# also look at the TribitsDevelopersGuilde.rst document and update it for the
-# new behvior of TriBITs!
+# in the guides/ReducedMockTrilinosOuptut/ directory and are used in the
+# TribitsUsersGuide.rst document.  Therefore, if the behavior of TriBITS
+# changes in such a way as to break these tests, then if any of the contents
+# of the files under this directory need to change, then one must also look at
+# the TribitsUsersGuilde.rst document and update it for the new behvior of
+# TriBITs!
 #
 
 

tribits/doc/build_docs.sh

@@ -13,16 +13,18 @@ _BASE_DIR=$PWD
 
 echo
 echo "***"
-echo "*** Generating TribitsDevelopersGuide.[rst,html,pdf] ..."
+echo "*** Generating Users and Maintainers guides ..."
 echo "***"
 echo
 
-cd $_BASE_DIR/developers_guide
-./generate-dev-guide.sh 
+cd $_BASE_DIR/guides/
+./generate-guide.sh all 
+cd -
 echo
 echo "See generated files:"
 echo
-ls $_BASE_DIR/developers_guide/TribitsDevelopersGuide.*
+ls $_BASE_DIR/guides/users_guide/TribitsUsersGuide.*
+ls $_BASE_DIR/guides/maintainers_guide/TribitsMaintainersGuide.*
 
 echo
 echo "***"

tribits/doc/build_ref/TribitsBuildReferenceBody.rst

@@ -1,12 +1,14 @@
 .. Common references to other documents
 
-.. _Package Dependencies and Enable/Disable Logic: https://tribits.org/doc/TribitsDevelopersGuide.html l#package-dependencies-and-enable-disable-logic
+.. _TriBITS Users Guide and Reference: TribitsUsersGuide.html
 
-.. _TriBITS Dependency Handling Behaviors: https://tribits.org/doc/TribitsDevelopersGuide.html#tribits-dependency-handling-behaviors
+.. _Package Dependencies and Enable/Disable Logic: TribitsUsersGuide.html#package-dependencies-and-enable-disable-logic
 
-.. _tribits_tpl_find_include_dirs_and_libraries(): https://tribits.org/doc/TribitsDevelopersGuide.html#tribits-tpl-find-include-dirs-and-libraries
+.. _TriBITS Dependency Handling Behaviors: TribitsUsersGuide.html#tribits-dependency-handling-behaviors
 
-.. _tribits_ctest_driver(): https://tribits.org/doc/TribitsDevelopersGuide.html#tribits-ctest-driver
+.. _tribits_tpl_find_include_dirs_and_libraries(): TribitsUsersGuide.html#tribits-tpl-find-include-dirs-and-libraries
+
+.. _tribits_ctest_driver(): TribitsUsersGuide.html#tribits-ctest-driver
 
 .. _Ninja: https://ninja-build.org
 

tribits/doc/developers_guide/.gitignore → tribits/doc/guides/.gitignore

@@ -4,20 +4,12 @@
 /TriBITS.README.DIRECTORY_CONTENTS.rst.tmp
 /TribitsCommonTPLsList.txt
 /TribitsCommonTPLsList.txt.tmp
-/TribitsDevelopersGuide.html
-/TribitsDevelopersGuide.pdf
 /TribitsGitVersion.txt
 /TribitsGitVersion.txt.tmp
 /TribitsHelloWorldDirAndFiles.txt
 /TribitsHelloWorldDirAndFiles.txt.tmp
-/TribitsMacroFunctionDoc.rst
-/TribitsMacroFunctionDoc.rst.tmp
 /TribitsStandardTPLsList.txt
 /TribitsStandardTPLsList.txt.tmp
-/TribitsSystemMacroFunctionDoc.rst
-/TribitsSystemMacroFunctionDoc.rst.tmp
-/UtilsMacroFunctionDoc.rst
-/UtilsMacroFunctionDoc.rst.tmp
 /checkin-test-help.txt
 /checkin-test-help.txt.tmp
 /clone_extra_repos-help.txt

tribits/doc/guides/Makefile.common_generated_files

@@ -0,0 +1,36 @@
+COMMON_DEPENDENT_FILES = \
+  Makefile \
+  ../generate-guide.sh \
+  ../TribitsGuidesBody.rst \
+  ../TribitsGuidesReferences.rst \
+  ../TribitsFAQ.rst \
+  ../TribitsHistory.rst \
+  ../TribitsPackageNotCMakePackage.rst \
+  ../TribitsDesignConsiderations.rst \
+  ../TribitsToolsDocumentation.rst \
+  ../TribitsStandardTPLsList.txt \
+  ../TribitsCommonTPLsList.txt \
+  ../checkin-test-help.txt \
+  ../gitdist-help.txt \
+  ../gitdist-dist-help-overview.txt \
+  ../gitdist-dist-help-repo-selection-and-setup.txt \
+  ../gitdist-dist-help-dist-repo-status.txt \
+  ../gitdist-dist-help-repo-versions.txt \
+  ../gitdist-dist-help-aliases.txt \
+  ../gitdist-dist-help-usage-tips.txt \
+  ../gitdist-dist-help-script-dependencies.txt \
+  ../gitdist-dist-help-all.txt \
+  ../clone_extra_repos-help.txt \
+  ../snapshot-dir-help.txt \
+  ../is_checkin_tested_commit.txt \
+  ../get-tribits-packages-from-files-list.txt \
+  ../install_devtools-help.txt \
+  ../TriBITS.README.DIRECTORY_CONTENTS.rst \
+  TribitsMacroFunctionDoc.rst \
+  UtilsMacroFunctionDoc.rst
+
+# NOTE: We *don't* want to rebuild the file if only the version has changed we
+# don't add a dependency on TribitsGitVersion.txt!
+
+# NOTE: The above paths are relative the the users_guide/ and
+# maintainers_guide/ subdirs.