projects / ceph.git / blame
| Commit | Line | Data |
|---|---|---|
| 7c673cae FG |
1 | <html> |
| 2 | <head> | |
| 3 | <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> | |
| 4 | <title>Step 7: Build the Docs</title> | |
| 5 | <link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> | |
| 6 | <meta name="generator" content="DocBook XSL Stylesheets V1.77.1"> | |
| 7 | <link rel="home" href="../../index.html" title="Boost.AutoIndex"> | |
| 8 | <link rel="up" href="../tut.html" title="Getting Started and Tutorial"> | |
| 9 | <link rel="prev" href="pis.html" title="Step 6: Using XML processing instructions to control what gets indexed."> | |
| 10 | <link rel="next" href="refine.html" title="Step 8: Iterate - to refine your index"> | |
| 11 | </head> | |
| 12 | <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> | |
| 13 | <table cellpadding="2" width="100%"><tr> | |
| 14 | <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> | |
| 15 | <td align="center"><a href="../../../../../../index.html">Home</a></td> | |
| 16 | <td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> | |
| 17 | <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> | |
| 18 | <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> | |
| 19 | <td align="center"><a href="../../../../../../more/index.htm">More</a></td> | |
| 20 | </tr></table> | |
| 21 | <hr> | |
| 22 | <div class="spirit-nav"> | |
| 23 | <a accesskey="p" href="pis.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../tut.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="refine.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> | |
| 24 | </div> | |
| 25 | <div class="section"> | |
| 26 | <div class="titlepage"><div><div><h3 class="title"> | |
| 27 | <a name="boost_autoindex.tut.build_docs"></a><a class="link" href="build_docs.html" title="Step 7: Build the Docs">Step 7: Build the Docs</a> | |
| 28 | </h3></div></div></div> | |
| 29 | <p> | |
| 30 | Using Boost.Build you build the docs with either: | |
| 31 | </p> | |
| 32 | <pre class="programlisting"><span class="identifier">bjam</span> <span class="identifier">release</span> <span class="special">></span> <span class="identifier">mylibrary_html</span><span class="special">.</span><span class="identifier">log</span> | |
| 33 | </pre> | |
| 34 | <p> | |
| 35 | To build the html docs or: | |
| 36 | </p> | |
| 37 | <pre class="programlisting"><span class="identifier">bjam</span> <span class="identifier">pdf</span> <span class="identifier">release</span> <span class="special">></span> <span class="identifier">mylibrary_pdf</span><span class="special">.</span><span class="identifier">log</span> | |
| 38 | </pre> | |
| 39 | <p> | |
| 40 | To build the pdf. | |
| 41 | </p> | |
| 42 | <p> | |
| 43 | During the build process you should see AutoIndex emit a message in the log | |
| 44 | file such as: | |
| 45 | </p> | |
| 46 | <pre class="programlisting">Indexing 990 terms... </pre> | |
| 47 | <p> | |
| 48 | If you don't see that, or if it's indexing 0 terms then something is wrong! | |
| 49 | </p> | |
| 50 | <p> | |
| 51 | Likewise when index generation is complete, AutoIndex will emit another message: | |
| 52 | </p> | |
| 53 | <pre class="programlisting">38 Index entries were created.</pre> | |
| 54 | <p> | |
| 55 | Again, if you see that 0 entries were created then something is wrong! | |
| 56 | </p> | |
| 57 | <p> | |
| 58 | Examine the log file, and if the cause is not obvious, make sure that you | |
| 59 | have <code class="literal"><auto-index-verbose>on</code> and that any needed | |
| 60 | <code class="literal">!debug regular-expression</code> directives are in your script | |
| 61 | file. | |
| 62 | </p> | |
| 63 | </div> | |
| 64 | <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> | |
| 65 | <td align="left"></td> | |
| 66 | <td align="right"><div class="copyright-footer">Copyright © 2008, 2011 John Maddock<p> | |
| 67 | Distributed under the Boost Software License, Version 1.0. (See accompanying | |
| 68 | file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) | |
| 69 | </p> | |
| 70 | </div></td> | |
| 71 | </tr></table> | |
| 72 | <hr> | |
| 73 | <div class="spirit-nav"> | |
| 74 | <a accesskey="p" href="pis.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../tut.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="refine.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> | |
| 75 | </div> | |
| 76 | </body> | |
| 77 | </html> |