34 lines
1.1 KiB
Plaintext
34 lines
1.1 KiB
Plaintext
[/
|
|
Copyright 2013-2018 Daniel James
|
|
|
|
Distributed under the Boost Software License, Version 1.0.
|
|
(See accompanying file LICENSE_1_0.txt or copy at
|
|
http://www.boost.org/LICENSE_1_0.txt)
|
|
]
|
|
|
|
[quickbook 1.7]
|
|
[chapter Introduction
|
|
[id boost_doc_tools.introduction]
|
|
]
|
|
|
|
Much of the boost documentation is generated using a collection of
|
|
documentation tools which make it easier to write documentation in the
|
|
boost style, and give a consistent look and feel. Setting up and
|
|
configuring these tools can be tricky, but once everything is in place,
|
|
it's mostly quite easy to use. There's no requirement to use any of
|
|
this, but feedback on the documentation generated with these tools
|
|
is generally positive.
|
|
|
|
The diagram below illustrates the way the various documentation tools
|
|
fit together. Note that you don't have to use all of this, and the
|
|
process is automated using Boost.Build, but having a rough
|
|
understanding of the build process will help understand the tools
|
|
better.
|
|
|
|
[?! __standalone__
|
|
[$../../tools/quickbook/doc/boost-doc-tools/images/documentation-toolchain.png]
|
|
]
|
|
[? __standalone__
|
|
[$../../boost-doc-tools/images/documentation-toolchain.png]
|
|
]
|