Debian Codegraph @

cmake/tribits/doc/build_ref/TribitsBuildReferenceTemplate.rst

raw
1 =================================================================
2 Generic TriBITS Project, Build, Test, and Install Reference Guide
3 =================================================================
4
5 :Author: Roscoe A. Bartlett
6 :Contact: [email protected]
7 :Date: |date|
8 :Version: .. include:: TribitsGitVersion.txt
9
10 .. |date| date::
11
12 :Abstract: This document is generated from the generic template body document ``TribitsBuildReferenceBody.rst`` and provides a general project-independent reference on how to configure, build, test, and install a project that uses the TriBITS CMake build system. The primary audience of this particular build of this document are TriBITS project developers themselves. A project-specific version of this document should be created and accessed by users of a particular TriBITS-based project.
13
14 .. sectnum::
15
16 .. contents::
17
18 Introduction
19 ============
20
21 This document is created using the script ``create-build-ref.sh`` in this
22 directory which just runs::
23
24 $ ./create-project-build-ref.py \
25 --project-name="<Project>" \
26 --project-template-file=TribitsBuildReferenceTemplate.rst \
27 --file-base=TribitsBuildReference
28
29 In a project-specific version, ``<Project>`` is replaced with the actual
30 project name (e.g. ``Trilinos``). This version of the generated document is
31 referred to by the general TribitsDeveloperGuide.[rst,html,pdf] document.
32
33 Below are given genetic versions of the sections that show up in every
34 project-specific build of this document.