[Units] can't view the documentation
I am very interested in the recently accepted Boost.Units library. I'm interested enough that I'd really like to read the documentation.... I have checked out the sources from the svn sandbox, but I can't seem to turn the units.qbk into something more readable. I tried the "obvious": run bjam in the docs directory, but that issues the complaint below. I added 'using boostbook;' to the user-config.jam in the top-level source directory, to no avail. I fear that I'm in a maze of twisty tools, all alike. a) is there an easy way to build the documentation or b) could some kind soul who has found their way through the maze of bbv2, boostbook, xsltproc, etc. do the rest of us a favor and put the html docs up on the web somewhere. $ bjam Building Boost.Regex with the optional Unicode/ICU support disabled. Please refer to the Boost.Regex documentation for more information (don't panic: this is a strictly optional feature). warning: No toolsets are configured. warning: Configuring default toolset "gcc". warning: If the default is wrong, you may not be able to build C++ programs. warning: Use the "--toolset=xxxxx" option to override our guess. warning: For more configuration options, please consult warning: http://boost.org/boost-build2/doc/html/bbv2/advanced/configuration.html warn: Unable to construct ./standalone error: the boostbook module is not initialized error: you've attempted to use the 'doxygen' toolset, error: which requires Boost.Book, error: but never initialized Boost.Book. error: Hint: add 'using boostbook ;' to your user-config.jam salmonj@drdws032.nyc$
On Dec 22, 2007 2:57 PM, John Salmon <john@thesalmons.org> wrote:
I am very interested in the recently accepted Boost.Units library.
[snip]
a) is there an easy way to build the documentation or
I don't know about easy, but instructions for setting up boostbook and quickbook are at: http://www.boost.org/doc/html/boostbook.html and http://www.boost-consulting.com/boost/tools/quickbook/doc/html/quickbook/ins...
b) could some kind soul who has found their way through the maze of bbv2, boostbook, xsltproc, etc. do the rest of us a favor and put the html docs up on the web somewhere.
If nothing else, I think you can find them in the version available from the vault: http://www.boost-consulting.com/vault/index.php?directory=Units HTH, Stjepan
On Dec 22, 2007 5:29 PM, Stjepan Rajko <stipe@asu.edu> wrote:
On Dec 22, 2007 2:57 PM, John Salmon <john@thesalmons.org> wrote:
I am very interested in the recently accepted Boost.Units library.
[snip]
a) is there an easy way to build the documentation or
I don't know about easy, but instructions for setting up boostbook and quickbook are at:
http://www.boost.org/doc/html/boostbook.html
and
http://www.boost-consulting.com/boost/tools/quickbook/doc/html/quickbook/ins...
b) could some kind soul who has found their way through the maze of bbv2, boostbook, xsltproc, etc. do the rest of us a favor and put the html docs up on the web somewhere.
If nothing else, I think you can find them in the version available from the vault:
http://www.boost-consulting.com/vault/index.php?directory=Units
HTH,
Stjepan _______________________________________________ Unsubscribe & other changes: http://lists.boost.org/mailman/listinfo.cgi/boost
Thanks. It turns out that the first of my problems was not adding --user-config=../../../user-config.jam to my command line. I naievely thought that if I created the file, it would be found. No dice. My second mistake was not realizing that the whitespace before the semi-colon is critical in the .jam file. It's 'using <space> doxygen <space> semicolon'. I still haven't figured out my third mistake :-(. This is what I get now ("I've snipped several hundred lines of apparantely successful generation of various files. I've kept what look like the errors and warnings.) Any help appreciated. I've got doxygen-1.5.4 in my path. /usr/bin/xsltproc is apparently from libxslt-1.1.11-1 salmonj@drdws032.nyc$ ../../../tools/jam/src/bin.linux/bjam --user-config=../../../user-config.jam html Building Boost.Regex with the optional Unicode/ICU support disabled. Please refer to the Boost.Regex documentation for more information (don't panic: this is a strictly optional feature). BoostBook warning: no DocBook XSL directory specified. If you have the DocBook XSL stylesheets installed, please set DOCBOOK_XSL_DIR to the stylesheet directory on either the command line (via -sDOCBOOK_XSL_DIR=...) or in a Boost.Jam configuration file. The DocBook XSL stylesheets are available here: http://docbook.sourceforge.net/ Stylesheets will be downloaded on-the-fly (very slow!) BoostBook warning: no DocBook DTD directory specified. If you have the DocBook DTD installed, please set DOCBOOK_DTD_DIR to the DTD directory on either the command line (via -sDOCBOOK_DTD_DIR=...) or in a Boost.Jam configuration file. The DocBook DTD is available here: http://www.oasis-open.org/docbook/xml/4.2/index.shtml The DTD will be downloaded on-the-fly (very slow!) ...patience... ...found 1042 targets... ...updating 48 targets... MkDir1 ../../../bin.v2/libs/units/doc MkDir1 ../../../bin.v2/libs/units/doc/gcc-3.4.4 MkDir1 ../../../bin.v2/libs/units/doc/gcc-3.4.4/debug quickbook.quickbook-to-boostbook ../../../bin.v2/libs/units/doc/gcc-3.4.4/debug/units.xml Generating Output File: ../../../bin.v2/libs/units/doc/gcc-3.4.4/debug/units.xml units.qbk:61: error: Syntax Error near column 73. units.qbk:62: error: Syntax Error near column 107. units.qbk:64: error: Syntax Error near column 84. units.qbk:65: error: Syntax Error near column 87. units.qbk:66: error: Syntax Error near column 79. units.qbk:437: error: Syntax Error near column 9. units.qbk:456: error: Syntax Error near column 9. doxygen-action ../../../bin.v2/libs/units/doc/gcc-3.4.4/debug/units_reference.xml Searching for include files... Searching for example files... Searching for images... Searching for dot files... Searching for files to exclude Searching for files to process... Reading and parsing tag files Preprocessing /u/salmonj/warez/boost_1_34_1/boost/units/systems/physical_units.hpp... Parsing file /u/salmonj/warez/boost_1_34_1/boost/units/systems/physical_units.hpp... Preprocessing /u/salmonj/warez/boost_1_34_1/boost/units/homogeneous_system.hpp... <snip> Generating XML output for file is_unit_of_system.hpp Generating XML output for file limits.hpp Generating XML output for file make_system.hpp Generating XML output for file operators.hpp /u/salmonj/warez/boost_1_34_1/boost/units/operators.hpp:19: Warning: Found unknown command `\detailed' Generating XML output for file quantity.hpp Generating XML output for file scaled_base_unit.hpp Generating XML output for file static_constant.hpp <snip> Generate XML output for dir /u/salmonj/warez/boost_1_34_1/boost/units/systems/ Generate XML output for dir /u/salmonj/warez/boost_1_34_1/boost/units/systems/temperature/ Generate XML output for dir /u/salmonj/warez/boost_1_34_1/boost/units/ xslt-xsltproc ../../../bin.v2/libs/units/doc/gcc-3.4.4/debug/temperature_reference.doxygen xslt-xsltproc ../../../bin.v2/libs/units/doc/gcc-3.4.4/debug/temperature_reference.boostbook MkDir1 html xslt-xsltproc ../../../bin.v2/libs/units/doc/gcc-3.4.4/debug/units.docbook warning: failed to load external entity "../../../libs/units/doc/units_reference.xml" ../../../bin.v2/libs/units/doc/gcc-3.4.4/debug/units.xml:1617: element include: XInclude error : could not load ../../../libs/units/doc/units_reference.xml, and no fallback was found warning: failed to load external entity "../../../libs/units/doc/si_reference.xml" ../../../bin.v2/libs/units/doc/gcc-3.4.4/debug/units.xml:1617: element include: XInclude error : could not load ../../../libs/units/doc/si_reference.xml, and no fallback was found warning: failed to load external entity "../../../libs/units/doc/cgs_reference.xml" ../../../bin.v2/libs/units/doc/gcc-3.4.4/debug/units.xml:1618: element include: XInclude error : could not load ../../../libs/units/doc/cgs_reference.xml, and no fallback was found warning: failed to load external entity "../../../libs/units/doc/base_units_reference.xml" ../../../bin.v2/libs/units/doc/gcc-3.4.4/debug/units.xml:1619: element include: XInclude error : could not load ../../../libs/units/doc/base_units_reference.xml, and no fallback was found warning: failed to load external entity "../../../libs/units/doc/dimensions_reference.xml" ../../../bin.v2/libs/units/doc/gcc-3.4.4/debug/units.xml:1620: element include: XInclude error : could not load ../../../libs/units/doc/dimensions_reference.xml, and no fallback was found warning: failed to load external entity "../../../libs/units/doc/trig_reference.xml" ../../../bin.v2/libs/units/doc/gcc-3.4.4/debug/units.xml:1620: element include: XInclude error : could not load ../../../libs/units/doc/trig_reference.xml, and no fallback was found warning: failed to load external entity "../../../libs/units/doc/temperature_reference.xml" ../../../bin.v2/libs/units/doc/gcc-3.4.4/debug/units.xml:1622: element include: XInclude error : could not load ../../../libs/units/doc/temperature_reference.xml, and no fallback was found warning: failed to load external entity "../../../libs/units/doc/abstract_reference.xml" ../../../bin.v2/libs/units/doc/gcc-3.4.4/debug/units.xml:1623: element include: XInclude error : could not load ../../../libs/units/doc/abstract_reference.xml, and no fallback was found warning: cannot find header `boost/units/systems/si.hpp' warning: cannot find header `boost/units/io.hpp' Cannot find class named 'boost::units::quantity' warning: cannot find header `boost/units/base_dimension.hpp' Cannot find class named 'boost::units::dim' Cannot find class named 'boost::units::static_rational' Cannot find class named 'boost::units::make_dimension_list' Cannot find class named 'boost::units::unit' warning: cannot find header `boost/units/unit.hpp' Cannot find class named 'boost::units::unit' Cannot find class named 'boost::units::unit' Cannot find function named 'boost::units::pow' Cannot find function named 'boost::units::root' Cannot find class named 'boost::units::static_rational' Cannot find class named 'boost::units::power_dimof_helper' Cannot find class named 'boost::units::root_typeof_helper' warning: cannot find header `boost/units/static_constant.hpp' Cannot find class named 'boost::units::base_unit_info' Cannot find class named 'boost::units::base_unit_info' Cannot find class named 'boost::units::quantity' warning: cannot find header `boost/units/quantity.hpp' Cannot find function named 'boost::units::pow' Cannot find function named 'boost::units::root' Cannot find method named 'boost::units::quantity::from_value' Cannot find function named 'boost::units::quantity_cast' Cannot find class named 'boost::units::quantity' Cannot find class named 'boost::units::quantity' Cannot find method named 'boost::units::quantity::from_value' warning: cannot find header `boost/units/conversion.hpp' warning: cannot find header `boost/units/absolute.hpp' warning: cannot find header `boost/units/implicit_conversion.hpp' Cannot find class named 'boost::units::unscale' Cannot find class named 'boost::units::scaled_base_unit' Cannot find class named 'boost::units::reduce_unit' Cannot find class named 'boost::units::base_unit' warning: cannot find header `boost/units/dimension.hpp' warning: cannot find header `boost/units/detail/utility.hpp' warning: cannot find header `libs/units/example/test_system.hpp' Cannot find class named 'boost::units::quantity' warning: cannot find header `boost/units/systems/si.hpp' Cannot find class named 'boost::units::power_dimof_helper' Cannot find class named 'boost::units::root_typeof_helper' Cannot find class named 'boost::units::quantity' Cannot find class named 'boost::units::quantity' Cannot find class named 'boost::units::quantity' Cannot find class named 'boost::units::quantity' Cannot find class named 'boost::units::power_dimof_helper' Cannot find class named 'boost::units::root_typeof_helper' Cannot find class named 'boost::units::quantity' Cannot find class named 'boost::units::quantity' Cannot find class named 'boost::units::power_dimof_helper' Cannot find class named 'boost::units::root_typeof_helper' Cannot find class named 'boost::units::add_typeof_helper' Cannot find class named 'boost::units::subtract_typeof_helper' Cannot find class named 'boost::units::multiply_typeof_helper' Cannot find class named 'boost::units::divide_typeof_helper' Cannot find class named 'boost::units::power_dimof_helper' Cannot find class named 'boost::units::root_typeof_helper' Cannot find class named 'boost::units::quantity' Cannot find class named 'boost::units::quantity' Cannot find class named 'boost::units::quantity' Cannot find class named 'boost::units::absolute' Cannot find class named 'boost::units::absolute' warning: cannot find header `boost/units/systems/si.hpp' warning: cannot find header `boost/units/systems/cgs.hpp' runtime error: file /u/salmonj/warez/boost_1_34_1/tools/boostbook/xsl/docbook.xsl line 338 element element xsl:element : no namespace bound to prefix xi runtime error: file /u/salmonj/warez/boost_1_34_1/tools/boostbook/xsl/docbook.xsl line 338 element element xsl:element : no namespace bound to prefix xi runtime error: file /u/salmonj/warez/boost_1_34_1/tools/boostbook/xsl/docbook.xsl line 338 element element xsl:element : no namespace bound to prefix xi runtime error: file /u/salmonj/warez/boost_1_34_1/tools/boostbook/xsl/docbook.xsl line 338 element element xsl:element : no namespace bound to prefix xi runtime error: file /u/salmonj/warez/boost_1_34_1/tools/boostbook/xsl/docbook.xsl line 338 element element xsl:element : no namespace bound to prefix xi runtime error: file /u/salmonj/warez/boost_1_34_1/tools/boostbook/xsl/docbook.xsl line 338 element element xsl:element : no namespace bound to prefix xi runtime error: file /u/salmonj/warez/boost_1_34_1/tools/boostbook/xsl/docbook.xsl line 338 element element xsl:element : no namespace bound to prefix xi runtime error: file /u/salmonj/warez/boost_1_34_1/tools/boostbook/xsl/docbook.xsl line 338 element element xsl:element : no namespace bound to prefix xi warning: cannot find header `boost/units/operators.hpp' warning: cannot find header `boost/units/systems/trig.hpp' Cannot find class named 'boost::units::unit' Cannot find class named 'boost::units::quantity' warning: cannot find header `boost/units/dimension.hpp' warning: cannot find header `boost/units/conversion.hpp' warning: cannot find header `boost/units/io.hpp' warning: cannot find header `boost/units/systems/abstract.hpp' warning: cannot find header `boost/units/systems/si/base.hpp' Cannot find class named 'boost::units::unit' warning: cannot find header `boost/units/cmath.hpp' error: file ../../../bin.v2/libs/units/doc/gcc-3.4.4/debug/units.xml xsltRunStylesheet : run failed XML_CATALOG_FILES=../../../bin.v2/libs/units/doc/gcc-3.4.4/debug/catalog.xml export XML_CATALOG_FILES "xsltproc" --stringparam boost.root ../../../.. --stringparam chunk.section.depth 8 --stringparam fop.extensions 0 --stringparam fop1.extensions 1 --stringparam toc.max.depth 1 --stringparam toc.section.depth 8 --xinclude -o "../../../bin.v2/libs/units/doc/gcc-3.4.4/debug/units.docbook" "/u/salmonj/warez/boost_1_34_1/tools/boostbook/xsl/docbook.xsl" "../../../bin.v2/libs/units/doc/gcc-3.4.4/debug/units.xml" ...failed xslt-xsltproc ../../../bin.v2/libs/units/doc/gcc-3.4.4/debug/units.docbook... ...skipped <phtml>HTML.manifest for lack of <p../../../bin.v2/libs/units/doc/gcc-3.4.4/debug>units.docbook... common.copy units_reference.boostbook common.copy si_reference.boostbook common.copy cgs_reference.boostbook common.copy base_units_reference.boostbook common.copy dimensions_reference.boostbook common.copy trig_reference.boostbook common.copy temperature_reference.boostbook doxygen-action ../../../bin.v2/libs/units/doc/gcc-3.4.4/debug/abstart_reference.xml Searching for include files... Searching for example files... Searching for images... <snip> Generate XML output for dir /u/salmonj/warez/boost_1_34_1/boost/units/systems/ Generate XML output for dir /u/salmonj/warez/boost_1_34_1/boost/units/ xslt-xsltproc ../../../bin.v2/libs/units/doc/gcc-3.4.4/debug/abstart_reference.doxygen xslt-xsltproc ../../../bin.v2/libs/units/doc/gcc-3.4.4/debug/abstart_reference.boostbook common.copy abstart_reference.boostbook ...failed updating 1 target... ...skipped 1 target... ...updated 46 targets... salmonj@drdws032.nyc$
John, It was a struggle, but I got a PDF to build: looks like the library docs still need more work. Anyhow I've put the PDF in the sandbox/units/libs/units/doc/ directory for now, Matthias Schabel and Steven Watanabe can remove it once they have an "official" version. Current issues with the PDF are: * Images for admonishments are missing. * Many code examples overflow the page width. * The Abstract System Reference doesn't seem to get built or included in the docs. HTH for now, John Maddock.
On Dec 23, 2007 5:20 AM, John Maddock <john@johnmaddock.co.uk> wrote:
John,
It was a struggle, but I got a PDF to build: looks like the library docs still need more work.
Anyhow I've put the PDF in the sandbox/units/libs/units/doc/ directory for now, Matthias Schabel and Steven Watanabe can remove it once they have an "official" version.
Very helpful. Thanks a lot! John Salmon
participants (3)
-
John Maddock -
John Salmon -
Stjepan Rajko