• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1[/
2    Copyright 2013-2018 Daniel James
3
4    Distributed under the Boost Software License, Version 1.0.
5    (See accompanying file LICENSE_1_0.txt or copy at
6    http://www.boost.org/LICENSE_1_0.txt)
7]
8
9[quickbook 1.7]
10[chapter Introduction
11[id boost_doc_tools.introduction]
12]
13
14Much of the boost documentation is generated using a collection of
15documentation tools which make it easier to write documentation in the
16boost style, and give a consistent look and feel. Setting up and
17configuring these tools can be tricky, but once everything is in place,
18it's mostly quite easy to use. There's no requirement to use any of
19this, but feedback on the documentation generated with these tools
20is generally positive.
21
22The diagram below illustrates the way the various documentation tools
23fit together. Note that you don't have to use all of this, and the
24process is automated using Boost.Build, but having a rough
25understanding of the build process will help understand the tools
26better.
27
28[?! __standalone__
29[$../../tools/quickbook/doc/boost-doc-tools/images/documentation-toolchain.png]
30]
31[? __standalone__
32[$../../boost-doc-tools/images/documentation-toolchain.png]
33]
34