Debian Codegraph @

cmake/tribits/doc/build_ref/README

raw
1 ================================================================================
2 TriBITS Build Reference Files
3 ================================================================================
4
5 This directory contains files to create a project-specific build quick
6 reference document <Project>BuildReference.[rst,html,pdf]. The generic files
7 used for this purpose are:
8
9 create-project-build-ref.py
10 TribitsBuildReferenceBody.rst
11
12 See `create-project-build-ref.py --help` for details.
13
14 This directory also contains a generic build of a <Project>BuildReference
15 document. The template file:
16
17 TribitsBuildReferenceTemplate.rst
18
19 is used to create the auto-generated (read-only) output files:
20
21 TribitsBuildReference.html
22 TribitsBuildReference.pdf
23 TribitsBuildReference.rst
24
25 using the script:
26
27 create-build-ref.sh
28
29 To run the script and update the output files, just do:
30
31 $ cd <this-dir>
32 $ ./create-build-ref.sh
33
34 That is all there is to it!
35
36 The generated documents are then referred to by other general TriBITS
37 documentation.