generating documentation in modular boost
I'm trying to update documentation in lib/utility but can't see how to regenerate the html files. Generalizing from the fact I can run the tests by invoking b2 within the module test subdirectory, I invoked b2 from within the doc subdirectory. This produced an error about an unknown feature "<format>" in Jamfile.v2. When I comment out those lines I do get xml files generated in a subdirectory of the superproject, but I expected html, matching what's been checked in. Is there documentation on building documentation that I haven't been able to find? Peter
-----Original Message----- From: Boost [mailto:boost-bounces@lists.boost.org] On Behalf Of Peter A. Bigot Sent: Monday, December 23, 2013 1:40 PM To: boost@lists.boost.org Subject: [boost] generating documentation in modular boost
I'm trying to update documentation in lib/utility but can't see how to regenerate the html files.
Generalizing from the fact I can run the tests by invoking b2 within the module test subdirectory, I invoked b2 from within the doc subdirectory. This produced an error about an unknown feature "<format>" in Jamfile.v2. When I comment out those lines I do get xml files generated in a subdirectory of the superproject, but I expected html, matching what's been checked in.
Is there documentation on building documentation that I haven't been able to find?
You need the full tool setup which is bit of a hassle involving your user jamfile and building Quickbook.exe. And I can't remember where immediately where this is described :-( So (having these tools setup) I've regenerated the docs - see attached. Paul
On 12/23/2013 08:28 AM, Paul A. Bristow wrote:
Is there documentation on building documentation that I haven't been able to find?
You need the full tool setup which is bit of a hassle involving your user jamfile and building Quickbook.exe.
And I can't remember where immediately where this is described :-(
So (having these tools setup) I've regenerated the docs - see attached.
Thanks for those, but I need this so I can see whether the changes I'm adding to a patch are formatted correctly. I just had success by doing a full build in the superproject to get quickbook built, and (most important) copying /opt/boost/tools/release/linux-user-config.jam to my home directory. That also eliminated the format feature error. All working now. Peter
On 23 December 2013 13:40, Peter A. Bigot <pab@pabigot.com> wrote:
Generalizing from the fact I can run the tests by invoking b2 within the module test subdirectory, I invoked b2 from within the doc subdirectory. This produced an error about an unknown feature "<format>" in Jamfile.v2. When I comment out those lines I do get xml files generated in a subdirectory of the superproject, but I expected html, matching what's been checked in.
This can be fixed by adding "using boostbook ;" next to where it says "using quickbook ;" in the utility jamfile. Then if the docbook files and xsltproc are installed in typical locations, the documentation build should work without any configuration.
participants (3)
-
Daniel James -
Paul A. Bristow -
Peter A. Bigot