trilinos16 added

trilinos_source16/cmake/tribits/doc/build_ref/.gitignore

@@ -0,0 +1,6 @@
+# Ignore generated files
+/TribitsBuildReference.html
+/TribitsBuildReference.pdf
+/TribitsBuildReference.rst
+/TribitsGitVersion.txt
+/TribitsGitVersion.txt.tmp

trilinos_source16/cmake/tribits/doc/build_ref/Makefile

@@ -0,0 +1,40 @@
+##---------------------------------------------------------------------------##
+## MAKEFILE
+##---------------------------------------------------------------------------##
+
+EXTRA_ARGS=
+
+.PHONY: clean realclean all
+
+BASE_NAME = TribitsBuildReference
+EXTRA_FILES = \
+  Makefile \
+  TribitsBuildReferenceBody.rst \
+  TribitsBuildReferenceTemplate.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!
+
+CREATE_PROJECT_BUILD_REF_CMND = \
+	./create-project-build-ref.py \
+	--project-name="<Project>" \
+	--project-template-file=TribitsBuildReferenceTemplate.rst \
+	--file-base=TribitsBuildReference
+
+all: $(EXTRA_FILES)
+	$(CREATE_PROJECT_BUILD_REF_CMND) \
+	$(EXTRA_ARGS)
+
+$(BASE_NAME).rst: $(EXTRA_FILES)
+	$(CREATE_PROJECT_BUILD_REF_CMND) \
+	--generate-html= --generate-latex= --generate-pdf= \
+	$(EXTRA_ARGS)
+
+clean:
+	-rm -f $(BASE_NAME).rst
+	-rm -f $(BASE_NAME).html
+	-rm -f $(BASE_NAME).pdf
+
+##---------------------------------------------------------------------------##
+## end of Makefile
+##---------------------------------------------------------------------------##

trilinos_source16/cmake/tribits/doc/build_ref/README

@@ -0,0 +1,37 @@
+================================================================================
+                       TriBITS Build Reference Files
+================================================================================
+
+This directory contains files to create a project-specific build quick
+reference document <Project>BuildReference.[rst,html,pdf].  The generic files
+used for this purpose are:
+
+  create-project-build-ref.py
+  TribitsBuildReferenceBody.rst
+
+See `create-project-build-ref.py --help` for details.
+
+This directory also contains a generic build of a <Project>BuildReference
+document.  The template file:
+
+  TribitsBuildReferenceTemplate.rst
+
+is used to create the auto-generated (read-only) output files:
+
+  TribitsBuildReference.html
+  TribitsBuildReference.pdf
+  TribitsBuildReference.rst
+
+using the script:
+
+  create-build-ref.sh
+
+To run the script and update the output files, just do:
+
+  $ cd <this-dir>
+  $ ./create-build-ref.sh
+
+That is all there is to it!
+
+The generated documents are then referred to by other general TriBITS
+documentation.