Boost logo

Boost-Commit :

Subject: [Boost-commit] svn:boost r59847 - sandbox/geometry/libs/geometry/doc/quickbook
From: mateusz_at_[hidden]
Date: 2010-02-22 18:59:42


Author: mloskot
Date: 2010-02-22 18:59:41 EST (Mon, 22 Feb 2010)
New Revision: 59847
URL: http://svn.boost.org/trac/boost/changeset/59847

Log:
Geometry: testing combining doxygen-based reference with quickbook (see Access Reference section).
Text files modified:
   sandbox/geometry/libs/geometry/doc/quickbook/Jamfile.v2 | 79 ++++++++++++++++++++++++++++++++-------
   sandbox/geometry/libs/geometry/doc/quickbook/reference.qbk | 3 +
   2 files changed, 67 insertions(+), 15 deletions(-)

Modified: sandbox/geometry/libs/geometry/doc/quickbook/Jamfile.v2
==============================================================================
--- sandbox/geometry/libs/geometry/doc/quickbook/Jamfile.v2 (original)
+++ sandbox/geometry/libs/geometry/doc/quickbook/Jamfile.v2 2010-02-22 18:59:41 EST (Mon, 22 Feb 2010)
@@ -9,28 +9,79 @@
 #project boost/libs/geometry/doc ;
 import boostbook : boostbook ;
 using quickbook ;
+using doxygen ;
 
+path-constant here : . ;
 path-constant images_location : html ;
 
-boostbook quickbook
+rule run_doxygen ( target : files * : name )
+{
+ doxygen $(target)
+ :
+ $(files)
+ :
+ <doxygen:param>EXTRACT_ALL=YES
+ <doxygen:param>EXPAND_ONLY_PREDEF=YES
+ <doxygen:param>HIDE_UNDOC_MEMBERS=NO
+ <doxygen:param>EXTRACT_PRIVATE=NO
+ <doxygen:param>ENABLE_PREPROCESSING=YES
+ <doxygen:param>MACRO_EXPANSION=YES
+ $(expand)
+ <doxygen:param>SEARCH_INCLUDES=NO
+ <reftitle>$(name)
+ ;
+
+}
+
+run_doxygen access_reference
+ :
+ [ glob $(here)/../../../../boost/geometry/core/access.hpp ]
+ :
+ "Access Reference"
+ ;
+
+xml geometry
     :
         geometry.qbk
     :
- # TODO: These paths assume Boost.Geometry lives in Boost tree
- <xsl:param>boost.root=../../../..
- <xsl:param>boost.libraries=../../../libraries.htm
- # TODO Use local path ../../../../doc/html/boostbook.css or similar
- # but temporarily link to online CSS - hmm, does not work, using private
- # copy of CSS is in quickbook/html/boostbook.css
- # <xsl:param>html.stylesheet=http://www.boost.org/doc/libs/1_41_0/doc/html/boostbook.css
- <xsl:param>html.stylesheet=http://mateusz.loskot.net/tmp/ggl/boostbook.css
- # TODO: Tweak these parameters
+ <dependency>access_reference
+ ;
+
+boostbook standalone
+ :
+ geometry
+ :
         <xsl:param>chunk.section.depth=4
         <xsl:param>chunk.first.sections=1
- <xsl:param>toc.section.depth=2
         <xsl:param>toc.max.depth=2
+ <xsl:param>toc.section.depth=2
         <xsl:param>generate.section.toc.level=4
- <format>html:<xsl:param>admon.graphics.path=images/
- <format>pdf:<xsl:param>boost.url.prefix=http://www.boost.org/doc/libs/release/libs/geometry/doc/html
- <format>pdf:<xsl:param>img.src.path=$(images_location)/
+#<xsl:param>toc.max.depth=1
+#<xsl:param>toc.section.depth=8
+#<xsl:param>chunk.section.depth=8
+ <xsl:param>boost.root="../../../.."
+ <xsl:param>html.stylesheet=http://mateusz.loskot.net/tmp/ggl/boostbook.css
+ <format>pdf:<xsl:param>boost.url.prefix=http://www.boost.org/doc/libs/release/doc/html
     ;
+
+#boostbook quickbook
+# :
+# geometry.qbk
+# :
+# # TODO: These paths assume Boost.Geometry lives in Boost tree
+# <xsl:param>boost.root=../../../..
+# <xsl:param>boost.libraries=../../../libraries.htm
+ # TODO Use local path ../../../../doc/html/boostbook.css or similar
+ # but temporarily link to online CSS - hmm, does not work, using private
+ # copy of CSS is in quickbook/html/boostbook.css
+ # <xsl:param>html.stylesheet=http://www.boost.org/doc/libs/1_41_0/doc/html/boostbook.css
+ # TODO: Tweak these parameters
+# <xsl:param>chunk.section.depth=4
+# <xsl:param>chunk.first.sections=1
+# <xsl:param>toc.section.depth=2
+# <xsl:param>toc.max.depth=2
+# <xsl:param>generate.section.toc.level=4
+# <format>html:<xsl:param>admon.graphics.path=images/
+# <format>pdf:<xsl:param>boost.url.prefix=http://www.boost.org/doc/libs/release/libs/geometry/doc/html
+# <format>pdf:<xsl:param>img.src.path=$(images_location)/
+# ;

Modified: sandbox/geometry/libs/geometry/doc/quickbook/reference.qbk
==============================================================================
--- sandbox/geometry/libs/geometry/doc/quickbook/reference.qbk (original)
+++ sandbox/geometry/libs/geometry/doc/quickbook/reference.qbk 2010-02-22 18:59:41 EST (Mon, 22 Feb 2010)
@@ -12,6 +12,7 @@
 ['TODO: full reference starts here...]
 
 [include geometries.qbk]
+[xinclude access_reference.xml]
 [include cs.qbk]
 [include algorithms.qbk]
 [include arithmetic.qbk]
@@ -20,4 +21,4 @@
 [include utilities.qbk]
 
 ['TODO: end of full reference...]
-[endsect] [/ end of section Reference]
\ No newline at end of file
+[endsect] [/ end of section Reference]


Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk