How To... Document a Project - Build Documentation

The centipede build system is self documenting. That is it puts information about the build being used for the project in ./src/documentation/xdocs/centipede. Whenever you run a build that includes the documentation this directory is updated with the latest information about the build in use. If you add a new antlib to the build it will be documented here automatically the next time you build the docs. Therefore, in order to include docs about your build system we simply need to insert a link to them.

To include these docs in your project site simply place a link in the root book.xml file by inserting the follwoing element into an appropriate menu:

    <menu-item label="Centipede" href="centipede/index.html"/>

Now if you rebuild the site docs (./build.sh site or ./build.bat site) you will be able to view the build system documents.