Boost-Commit :

Date view	Thread view	Subject view	Author view

Subject: [Boost-commit] svn:boost r85000 - in trunk: doc doc/html doc/src libs/circular_buffer libs/circular_buffer/doc
From: john_at_[hidden]
Date: 2013-07-10 12:19:38

Author: johnmaddock
Date: 2013-07-10 12:19:37 EDT (Wed, 10 Jul 2013)
New Revision: 85000
URL: http://svn.boost.org/trac/boost/changeset/85000

Log:
Commit of circular buffer doc build.

Added:
   trunk/doc/html/circular_buffer.html (contents, props changed)
Text files modified:
   trunk/doc/Jamfile.v2 | 3 +
   trunk/doc/html/circular_buffer.html | 17 ++++++
   trunk/doc/src/boost.xml | 14 +---
   trunk/libs/circular_buffer/doc/circular_buffer.qbk | 6 +-
   trunk/libs/circular_buffer/doc/jamfile.v2 | 113 ++++++---------------------------------
   trunk/libs/circular_buffer/index.html | 6 +
   6 files changed, 49 insertions(+), 110 deletions(-)

Modified: trunk/doc/Jamfile.v2
==============================================================================
--- trunk/doc/Jamfile.v2 Wed Jul 10 12:10:44 2013 (r84999)
+++ trunk/doc/Jamfile.v2 2013-07-10 12:19:37 EDT (Wed, 10 Jul 2013) (r85000)
@@ -40,6 +40,7 @@
 <dependency>../libs/accumulators/doc//statsdoc.xml
 <dependency>../libs/accumulators/doc//opdoc.xml
 <dependency>../libs/accumulators/doc//accumulators
+ <dependency>../libs/circular_buffer/doc//standalone/<format>docbook
 <dependency>../libs/conversion/doc//lexical_cast
 <dependency>../libs/chrono/doc//chrono
 <dependency>../libs/program_options/doc//autodoc.xml
@@ -102,6 +103,7 @@
 <implicit-dependency>../tools/build/v2/doc//jam_docs
 <implicit-dependency>../tools/quickbook/doc//quickbook
 <implicit-dependency>../libs/mpi/doc//mpi
+ <implicit-dependency>../libs/circular_buffer/doc//standalone/<format>docbook
 <implicit-dependency>../libs/container/doc//standalone/<format>docbook
 <implicit-dependency>../libs/interprocess/doc//standalone/<format>docbook
 <implicit-dependency>../libs/intrusive/doc//standalone/<format>docbook
@@ -130,3 +132,4 @@

+

Added: trunk/doc/html/circular_buffer.html
==============================================================================
--- /dev/null 00:00:00 1970 (empty, because file is newly added)
+++ trunk/doc/html/circular_buffer.html 2013-07-10 12:19:37 EDT (Wed, 10 Jul 2013) (r85000)
@@ -0,0 +1,17 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+ <head>
+ 
+ <title>Redirect to generated documentation</title>
+ <meta http-equiv="refresh" content="0; URL=http://boost-sandbox.sourceforge.net/doc/html/circular_buffer.html">
+ </head>
+ <body>
+ Automatic redirection failed, please go to
+ http://boost-sandbox.sourceforge.net/doc/html/circular_buffer.html
+ </body>
+</html>
+

Modified: trunk/doc/src/boost.xml
==============================================================================
--- trunk/doc/src/boost.xml Wed Jul 10 12:10:44 2013 (r84999)
+++ trunk/doc/src/boost.xml 2013-07-10 12:19:37 EDT (Wed, 10 Jul 2013) (r85000)
@@ -98,17 +98,7 @@

 <xi:include href="chrono.xml"/>

- <library name="Circular Buffer" dirname="circular_buffer" html-only="1"
- url="../../libs/circular_buffer/index.html">
- <libraryinfo>
- <author>
- <firstname>Jan</firstname>
- <surname>Gaspar</surname>
- </author>
- <librarypurpose>A STL compliant container also known as ring or cyclic buffer</librarypurpose>
- <librarycategory name="category:containers"/>
- </libraryinfo>
- </library>
+ <xi:include href="circular_buffer.auto_index.docbook"/>

 <library name="Compatibility" dirname="compatibility" html-only="1">
 <libraryinfo>
@@ -764,3 +754,5 @@

+
+

Modified: trunk/libs/circular_buffer/doc/circular_buffer.qbk
==============================================================================
--- trunk/libs/circular_buffer/doc/circular_buffer.qbk Wed Jul 10 12:10:44 2013 (r84999)
+++ trunk/libs/circular_buffer/doc/circular_buffer.qbk 2013-07-10 12:19:37 EDT (Wed, 10 Jul 2013) (r85000)
@@ -49,7 +49,7 @@

[def __debug_support [link circular_buffer.implmentation.debug_support debug support]]

-[include ../../../boost-trunk/tools/auto_index/include/auto_index_helpers.qbk]
+[include ../../../tools/auto_index/include/auto_index_helpers.qbk]
[/ Must be first included file!]

[note A printer-friendly PDF version of this manual is also available.]
@@ -559,11 +559,9 @@
[/ The position of this in the Quickbook determines the location of the Doxygen references section.]
[/ Index(es) should be invoked in the main module, not within a section.]

-[? enable_index
'''
 <index/>
'''
-]

[/ circular_buffer.qbk
 Copyright 2013 Paul A. Bristow.
@@ -573,3 +571,5 @@
 (See accompanying file LICENSE_1_0.txt or copy at
 http://www.boost.org/LICENSE_1_0.txt).
]
+
+

Modified: trunk/libs/circular_buffer/doc/jamfile.v2
==============================================================================
--- trunk/libs/circular_buffer/doc/jamfile.v2 Wed Jul 10 12:10:44 2013 (r84999)
+++ trunk/libs/circular_buffer/doc/jamfile.v2 2013-07-10 12:19:37 EDT (Wed, 10 Jul 2013) (r85000)
@@ -18,46 +18,11 @@
echo "images_location = " $(images_location) ; # images_location = I:\boost-trunk\libs\circular_buffer\doc\html\images
echo "pdf_images_location = " $(pdf_images_location) #
import modules ;
-
-if --enable-index in [ modules.peek : ARGV ]
-{
- ECHO "Building the docs with automatic index generation enabled." ;
- using auto-index ;
- project : requirements
-
- <auto-index>on # Turns on index (or off).
- # Turns on (or off) index-verbose for diagnostic info (using /bin auto-index-verbose folders).
- <auto-index-verbose>on
-
- # Choose indexing method (separately for html and pdf):
- <format>html:<auto-index-internal>on # on (or off) to use internally generated indexes.
- # <format>html:<xsl:param>generate.index=0 # Don't let the XSL stylesheets generate indexes.
-
- <format>pdf:<auto-index-internal>off # on (or off) to use internally generated indexes.
- # <auto-index-type>index # Use <index>...</index> as the XML wrapper.
-
- <format>html:<xsl:param>index.on.type=1 # = 1 For the native stylesheets to generate multiple different indexes.
-
- # PDF native index support is probably better for PDFs as then you actually get page numbers.
-
- <auto-index-script>circular_buffer.idx # Specifies the name of the script to load for circular_buffer.
- <auto-index-prefix>../../.. # Will get you back up to /circular_buffer, so !scan-path "boost/circular_buffer/" is where *.hpp will be,
- # and /libs/circular_buffer for other files.
- # Without this would need !scan-path "../../../boost/circular_buffer"
-
- <quickbook-define>enable_index ;
- # Used by Quickbook to invoke indexing.
-}
-else
-{
- ECHO "Building the my_library docs with automatic index generation disabled. To get an auto-index, try building with --enable-index." ;
-}
-
using auto-index ;
-
using doxygen ; # Required if you want to use Doxygen.
using quickbook ;

+
doxygen autodoc
 :
 # List all the files individually (RECURSIVE=NO ).
@@ -138,26 +103,7 @@

 # General settings
 # =================
- # Path for links to Boost.
- <xsl:param>boost.root=../../../..
- # Path for libraries index, for example: http://www.boost.org/doc/libs/1_53_0/libs/libraries.htm:
- <xsl:param>boost.libraries=../../../../../boost-trunk/libs/libraries.htm

- # Use the main Boost stylesheet:
- #<xsl:param>html.stylesheet=../../doc/html/boostbook.css
- # Use local stylsheet
- <xsl:param>html.stylesheet=boostbook.css
- # <xsl:param>html.stylesheet=./boostbook.css
- #<xsl:param>img.src.path=../images/ # graphics (diagrams) for html.
- <xsl:param>nav.layout=horizontal # to get a horizontal navigation bar (you probably DO want this).
-
- # Path for links to Boost logo.
- #<xsl:param>boost.root=.. # already defined
- <xsl:param>boost.image=Boost # options are: none (no logo), Boost (for boost.png), or your own logo, for example, inspired_by_boost.png
- <xsl:param>boost.image.src=../images/draft_for_boost.png #
- <xsl:param>boost.image.w=180 # Width of logo in pixels. (JM has W = 162, h = 46)
- <xsl:param>boost.image.h=90 # Height of logo in pixels.
-
 # Options for html and pdf
 # ========================
 # No indent on body text:
@@ -189,31 +135,25 @@
 <format>html:<xsl:param>html.cellpadding=5 # pixels
 # Not sure if these are right way round?

+ <auto-index>on # Turns on index (or off).
+ # Turns on (or off) index-verbose for diagnostic info (using /bin auto-index-verbose folders).
+ <auto-index-verbose>on
+
+ <format>pdf:<auto-index-internal>off # on (or off) to use internally generated indexes.
+
+ <format>html:<xsl:param>index.on.type=1 # = 1 For the native stylesheets to generate multiple different indexes.
+
+ <auto-index-script>circular_buffer.idx # Specifies the name of the script to load for circular_buffer.
+ <auto-index-prefix>../../.. # Will get you back up to /circular_buffer, so !scan-path "boost/circular_buffer/" is where *.hpp will be,
+ # and /libs/circular_buffer for other files.
+ # Without this would need !scan-path "../../../boost/circular_buffer"
+
+ # Used by Quickbook to invoke indexing.
 # Required by boost-trunk/doc/ see jamfile.v2 to use auto-index.
 # Choose indexing method for html:
 <format>html:<auto-index-internal>on
 <format>docbook:<auto-index-internal>on

- # Set the name of the script file to use (library_name.idx is good):
- <auto-index-script>$(here)/circular_buffer.idx
- # Commands in the script file should all use RELATIVE PATHS
- # otherwise the script will not be portable to other machines.
- # Relative paths are normally taken as relative to the location
- # of the script file, but we can add a prefix to all
- # those relative paths using the <auto-index-prefix> feature.
- # The path specified by <auto-index-prefix> may be either relative or
- # absolute, for example the following will get us up to the boost root
- # directory for most Boost libraries:
- <auto-index-prefix>"$(here)/../../.."
-
- <format>html:<xsl:param>boost.root=../../../..
- <format>html:<xsl:param>boost.libraries=../../../../libs/libraries.htm
-
-# Finally, in boost.xml we xi:include circular_buffer.auto_index.docbook which is the final
-# post-index generation docbook, rather than circular_buffer.xml
-# which is the pre-indexed boostbook.
-
-
 # PDF Options:
 # ============
 # TOC Generation: this is needed for FOP-0.9 and later:
@@ -240,32 +180,17 @@
 <format>pdf:<xsl:param>admon.graphics.path=$(nav_images)/ # next, prev, note, tip ... for pdf.
 <format>pdf:<xsl:param>use.role.for.mediaobject=1
 <format>pdf:<xsl:param>preferred.mediaobject.role=print
- <format>pdf:<xsl:param>img.src.path=$(pdf_images_location)/ # graphics (diagrams) for pdf.
+ <format>pdf:<xsl:param>img.src.path=$(pdf_images_location)/ # graphics (diagrams) for pdf.
 <format>pdf:<xsl:param>draft.mode="no"
- #<format>pdf:<xsl:param>boost.url.prefix=I:/boost-trunk/boost/circular_buffer/libs/circular_buffer/doc/html
- #<format>pdf:<xsl:param>boost.url.prefix=http://www.boost.org/doc/libs/release/libs/circular_buffer/doc/html
- #<format>pdf:<xsl:param>boost.url.prefix=http://www.boost.org/doc/libs/release/libs/math/doc/html

 <dependency>autodoc #
- <dependency>css-install
- <dependency>png-install
- #<dependency>svg-install
+ <dependency>png_install
 ;

-# Install (copy) the 'master' copy of boostbook Cascading Style sheet from your current Boost-root.
-path-constant boost-root : [ modules.peek : BOOST ] ;
-
-echo "BOOST ROOT" $(boost-root) ;
-
-#install css-install : $(boost-root)/doc/src/boostbook.css : <location>html ;
-install css-install : ./boostbook.css : <location>html ; # copy a local version of boostbook.css to /html
-#install images-install : /images/circular_buffer.png : <location>html ; # copy a local version of /images to /html
-
# Install (copy) the 'master' copies of all icon images (both PNG and SVG)
# and the Boost logo from your current Boost-root
# to the local /doc/html/images folder so that html is complete and standalone.
- install png-install : [ glob ./images/*.png ] : <location>html/images ;
-# install svg-install : [ glob $(boost-root)/doc/images/*.svg ] : <location>html/images ;
+install png_install : [ glob $(here)/*.png ] : <location>$(here)/../../../doc/html/images ;

# install pdf-install : standalone : <install-type>PDF <location>. ;
# Effectively copies the file from \bin folder to the \doc folder,
@@ -275,5 +200,5 @@

install pdf-install : standalone : <install-type>PDF <location>. <name>circular_buffer.pdf ;

-install html-install : standalone : <location>. ;
+

Modified: trunk/libs/circular_buffer/index.html
==============================================================================
--- trunk/libs/circular_buffer/index.html Wed Jul 10 12:10:44 2013 (r84999)
+++ trunk/libs/circular_buffer/index.html 2013-07-10 12:19:37 EDT (Wed, 10 Jul 2013) (r85000)
@@ -2,14 +2,14 @@
"http://www.w3.org/TR/html4/loose.dtd">
<html>
 <head>
- <meta http-equiv="refresh" content="0; URL=doc/circular_buffer.html">
+ <meta http-equiv="refresh" content="0; URL=../../doc/html/circular_buffer.html">
 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
 <title>
 Redirection
 </title>
 </head>
 <body>
- Automatic redirection failed, please go to circular_buffer.html.
+ Automatic redirection failed, please go to circular_buffer.html.
 
 Copyright © 2003-2008 Jan Gaspar
 
@@ -20,3 +20,5 @@
 
 </body>
</html>
+
+

Date view	Thread view	Subject view	Author view

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