When using quickbook to write the docs, the .qbk file is the only one
maintained by hand. Should the generated html files also be committed
into
CVS, or will they be generated automatically by some kind of a
build/install
process? I remember seeing something on the net about MetaCommunications
building the docs, but I no longer able to find it...
This is for a Boost Library right?
Basically:
1) Ensure that your docs are built from boost-root/doc/Jamfile.v2
Look at what other quickbook based docs do there for examples.
2) Ensure your library has an entry in boost-root/doc/src/boost.xml, again
look at the others for examples.
3) Make sure that the docs build correctly from boost-root/doc (and look
correct) before you commit anything.
4) Add a file boost-root/libs/mylibrary/index.html that redirects to the
BoostBook generated docs for your library which are under
boost-root/doc/html/mylibname.html
5) Modify the boost-root/doc/html/mylibname.html file to redirect to the
metacomm generated docs (so now you get redirected twice if you open
boost-root/libs/mylibrary/index.html), and commit this file also.
static assert and type traits will have all the examples you need, just copy
what they do, and it should all work (I hope!).
John.
-------------------------------------------------------
This SF.Net email is sponsored by:
Power Architecture Resource Center: Free content, downloads, discussions,
and more. http://solutions.newsforge.com/ibmarch.tmpl
_______________________________________________
Boost-docs mailing list
[email protected]
Unsubscribe and other administrative requests:
https://lists.sourceforge.net/lists/listinfo/boost-docs
