一旦 BoostBook 完成配置,我们就可以构建一些文档。首先,切换到目录 $BOOST_ROOT/doc
并移除(或设置为可写)$BOOST_ROOT/doc/html
中的 .html
文件。然后,运行 bjam
以构建 HTML 文档。当从 BoostBook 文档构建 DocBook 文档时,您应该会看到如下所示的几个警告
Cannot find function named 'checked_delete' Cannot find function named 'checked_array_delete' Cannot find function named 'next'
当 Boost 文档工具无法找到源代码中引用但没有文档的功能、方法或类时,会发出这些警告,并且这些警告在任何方面都是无害的。一旦 Boost.Jam 完成执行,Boost 的 HTML 文档将在 $BOOST_ROOT/doc/html
中可用。您还可以使用命令行 bjam onehtml
在单个(大型!)HTML 文件中创建 HTML 文档,或者使用命令行 bjam man
创建 Unix man 手册页。完整的输出格式列表在表格 2.1,“BoostBook 输出格式”中列出。可以将多种输出格式传递给 bjam
的单个调用,例如,bjam html man docbook
将生成 HTML(多个文件)、man 手册页和 DocBook 文档。
表格 2.1. BoostBook 输出格式
格式 | 描述 |
---|---|
html | HTML 输出(多个文件)。这是默认设置 |
onehtml | HTML 输出,在单个 HTML 文件中。 |
man | Unix man 手册页。 |
PDF。需要 Apache FOP。 |
|
ps | Postscript。需要 Apache FOP。 |
docbook | DocBook. |
fo | XSL 格式化对象 |