|
|
Boost-Commit : |
From: agurtovoy_at_[hidden]
Date: 2008-06-17 17:46:24
Author: agurtovoy
Date: 2008-06-17 17:46:20 EDT (Tue, 17 Jun 2008)
New Revision: 46462
URL: http://svn.boost.org/trac/boost/changeset/46462
Log:
MPL docs: README, build script, and numerous fixes to bring up docs generation (unfinished)
Added:
trunk/libs/mpl/doc/src/README.txt (contents, props changed)
trunk/libs/mpl/doc/src/build.py (contents, props changed)
trunk/libs/mpl/doc/src/docutils/
trunk/libs/mpl/doc/src/docutils/setup.py (contents, props changed)
trunk/libs/mpl/doc/src/docutils/tools/
trunk/libs/mpl/doc/src/docutils/tools/rst2htmlrefdoc.py (contents, props changed)
trunk/libs/mpl/doc/src/docutils/writers/
trunk/libs/mpl/doc/src/docutils/writers/html4_refdoc/
trunk/libs/mpl/doc/src/docutils/writers/html4_refdoc/__init__.py (contents, props changed)
trunk/libs/mpl/doc/src/docutils/writers/html4_refdoc/frames.css (contents, props changed)
Text files modified:
trunk/libs/mpl/doc/src/refmanual/AUX_LAMBDA_SUPPORT.rst | 3 -
trunk/libs/mpl/doc/src/refmanual/Acknowledgements.rst | 2
trunk/libs/mpl/doc/src/refmanual/Algorithms-Iteration.rst | 2
trunk/libs/mpl/doc/src/refmanual/Algorithms-Querying.rst | 2
trunk/libs/mpl/doc/src/refmanual/Algorithms-Runtime.rst | 2
trunk/libs/mpl/doc/src/refmanual/Algorithms-Transformation.rst | 2
trunk/libs/mpl/doc/src/refmanual/Algorithms.rst | 7 ++---
trunk/libs/mpl/doc/src/refmanual/AssociativeSequence.rst | 8 +++---
trunk/libs/mpl/doc/src/refmanual/CFG_NO_PREPROCESSED.rst | 3 -
trunk/libs/mpl/doc/src/refmanual/Categorized.rst | 2
trunk/libs/mpl/doc/src/refmanual/Data.rst | 2
trunk/libs/mpl/doc/src/refmanual/Iterators-Concepts.rst | 1
trunk/libs/mpl/doc/src/refmanual/Iterators-Metafunctions.rst | 2
trunk/libs/mpl/doc/src/refmanual/Iterators.rst | 2
trunk/libs/mpl/doc/src/refmanual/Macros-Asserts.rst | 1
trunk/libs/mpl/doc/src/refmanual/Macros-Configuration.rst | 2
trunk/libs/mpl/doc/src/refmanual/Macros.rst | 2
trunk/libs/mpl/doc/src/refmanual/Metafunctions-Arithmetic.rst | 6 +---
trunk/libs/mpl/doc/src/refmanual/Metafunctions-Bitwise.rst | 6 +---
trunk/libs/mpl/doc/src/refmanual/Metafunctions-Comparisons.rst | 6 +---
trunk/libs/mpl/doc/src/refmanual/Metafunctions-Composition.rst | 7 +----
trunk/libs/mpl/doc/src/refmanual/Metafunctions-Conditional.rst | 5 +--
trunk/libs/mpl/doc/src/refmanual/Metafunctions-Invocation.rst | 5 +--
trunk/libs/mpl/doc/src/refmanual/Metafunctions-Logical.rst | 4 --
trunk/libs/mpl/doc/src/refmanual/Metafunctions-Trivial.rst | 28 +++++++---------------
trunk/libs/mpl/doc/src/refmanual/Metafunctions-Type.rst | 5 +--
trunk/libs/mpl/doc/src/refmanual/Metafunctions.rst | 2
trunk/libs/mpl/doc/src/refmanual/Sequences-Classes.rst | 2
trunk/libs/mpl/doc/src/refmanual/Sequences-Concepts.rst | 5 +--
trunk/libs/mpl/doc/src/refmanual/Sequences-Intrinsic.rst | 2
trunk/libs/mpl/doc/src/refmanual/Sequences-Views.rst | 2
trunk/libs/mpl/doc/src/refmanual/Sequences.rst | 2
trunk/libs/mpl/doc/src/refmanual/TagDispatchedMetafunction.rst | 7 +----
trunk/libs/mpl/doc/src/refmanual/VariadicSequence.rst | 12 +++------
trunk/libs/mpl/doc/src/refmanual/bool_.rst | 9 +-----
trunk/libs/mpl/doc/src/refmanual/for_each.rst | 4 +-
trunk/libs/mpl/doc/src/refmanual/inserter_.rst | 4 --
trunk/libs/mpl/doc/src/refmanual/refmanual.py | 10 +++++---
trunk/libs/mpl/doc/src/refmanual/refmanual.rst | 48 ++++++++++++++++-----------------------
trunk/libs/mpl/doc/src/refmanual/terminology.rst | 20 +++++----------
40 files changed, 95 insertions(+), 151 deletions(-)
Added: trunk/libs/mpl/doc/src/README.txt
==============================================================================
--- (empty file)
+++ trunk/libs/mpl/doc/src/README.txt 2008-06-17 17:46:20 EDT (Tue, 17 Jun 2008)
@@ -0,0 +1,39 @@
+
+Building the documenation
+*************************
+
+Prerequisites
+-------------
+
+* Python_ 2.3 or higher
+
+* Docutils_ 0.4 or higher
+
+* Docutils `HTML/frames writer`_ from Docutils Sandbox. Download it as
+ a part of daily `Sandbox snapshot`_ at or get it from the `Docutils'
+ Subversion repository`_.
+
+
+Building
+--------
+
+1. Install prerequisites.
+
+2. Make sure your Python ``Scripts`` directory (e.g. ``C:\Python25\Scripts``)
+ is in your search path.
+
+3. Go to ``$BOOST_ROOT/libs/mpl/doc/src/docutils`` directory and do
+ ``python setup.py install`` to install MPL-specific HTML/refdoc Docutils
+ writer.
+
+4. Do ``python build.py``. It's going to take a couple of minutes to finish.
+
+5. If all goes well, the resulting HTML docs will be placed in
+ ``$BOOST_ROOT/libs/mpl/doc/src/refmanual/build/`` directory.
+
+
+.. _Python: http://python.org/
+.. _Docutils: http://docutils.sourceforge.net/
+.. _HTML/frames writer: http://docutils.sourceforge.net/sandbox/agurtovoy/html_frames/
+.. _Sandbox snapshot: http://docutils.sourceforge.net/docutils-sandbox-snapshot.tgz
+.. _Docutils' Subversion repository: http://docutils.sourceforge.net/docs/dev/repository.html
Added: trunk/libs/mpl/doc/src/build.py
==============================================================================
--- (empty file)
+++ trunk/libs/mpl/doc/src/build.py 2008-06-17 17:46:20 EDT (Tue, 17 Jun 2008)
@@ -0,0 +1,30 @@
+# Copyright (c) Aleksey Gurtovoy 2008
+#
+# Distributed under the Boost Software License, Version 1.0.
+# (See accompanying file LICENSE_1_0.txt or copy at
+# http://www.boost.org/LICENSE_1_0.txt)
+
+import shutil
+import os
+
+
+def build():
+
+ def cleanup():
+ if os.path.exists( 'refmanual.gen' ):
+ os.unlink( 'refmanual.gen' )
+
+ if os.path.exists( 'build' ):
+ shutil.rmtree( 'build' )
+
+ def generate_html():
+ os.system( 'python refmanual.py' )
+ os.mkdir( 'build' )
+ os.system( 'rst2htmlrefdoc.py -g -d -t --no-frames --traceback refmanual.gen build/refmanual.html' )
+
+ os.chdir( 'refmanual' )
+ cleanup()
+ generate_html()
+
+
+build()
Added: trunk/libs/mpl/doc/src/docutils/setup.py
==============================================================================
--- (empty file)
+++ trunk/libs/mpl/doc/src/docutils/setup.py 2008-06-17 17:46:20 EDT (Tue, 17 Jun 2008)
@@ -0,0 +1,23 @@
+#!/usr/bin/env python
+
+# Copyright Aleksey Gurtovoy 2007-2008
+#
+# Distributed under the Boost Software License, Version 1.0.
+# (See accompanying file LICENSE_1_0.txt or copy at
+# http://www.boost.org/LICENSE_1_0.txt)
+
+
+import sys, os
+from distutils.core import setup
+
+setup(
+ name="html_refdoc",
+ version=".1",
+ description="convert C++ rst documentation to a set of HTML pages/frames.",
+ author="Aleksey Gurtovoy",
+ author_email="agurtovoy_at_[hidden]",
+ packages=['docutils.writers.html4_refdoc'],
+ package_dir={'docutils.writers.html4_refdoc': 'writers/html4_refdoc'},
+ package_data={'docutils.writers.html4_refdoc': ['frames.css']},
+ scripts=["tools/rst2htmlrefdoc.py"],
+ )
Added: trunk/libs/mpl/doc/src/docutils/tools/rst2htmlrefdoc.py
==============================================================================
--- (empty file)
+++ trunk/libs/mpl/doc/src/docutils/tools/rst2htmlrefdoc.py 2008-06-17 17:46:20 EDT (Tue, 17 Jun 2008)
@@ -0,0 +1,22 @@
+#!/usr/bin/env python
+
+# Copyright Aleksey Gurtovoy 2004-2008
+#
+# Distributed under the Boost Software License, Version 1.0.
+# (See accompanying file LICENSE_1_0.txt or copy at
+# http://www.boost.org/LICENSE_1_0.txt)
+
+
+import locale
+try:
+ locale.setlocale(locale.LC_ALL, '')
+except:
+ pass
+
+from docutils.core import publish_cmdline, default_description
+
+
+description = ('Generates "framed" (X)HTML documents from standalone reStructuredText '
+ 'sources. ' + default_description)
+
+publish_cmdline(writer_name='html4_refdoc', description=description)
Added: trunk/libs/mpl/doc/src/docutils/writers/html4_refdoc/__init__.py
==============================================================================
--- (empty file)
+++ trunk/libs/mpl/doc/src/docutils/writers/html4_refdoc/__init__.py 2008-06-17 17:46:20 EDT (Tue, 17 Jun 2008)
@@ -0,0 +1,231 @@
+
+# Copyright Aleksey Gurtovoy 2004-2008
+#
+# Distributed under the Boost Software License, Version 1.0.
+# (See accompanying file LICENSE_1_0.txt or copy at
+# http://www.boost.org/LICENSE_1_0.txt)
+
+from docutils.writers import html4_frames
+from docutils.writers import html4css1
+from docutils import nodes
+
+import re
+import string
+
+
+class Writer(html4_frames.Writer):
+
+ def __init__(self):
+ self.__super = html4_frames.Writer
+ self.__super.__init__(self)
+ self.translator = refdoc_translator
+
+
+class refdoc_translator(html4_frames.frame_pages_translator):
+
+ tocframe_width = 25
+
+ def __init__(self, document, index_page, page_files_dir, extension):
+ self.docframe += ' refmanual'
+ self.__super = html4_frames.frame_pages_translator
+ self.__super.__init__(self, document, index_page, page_files_dir, extension)
+ self.page_translator = hacked_html_translator
+ self.re_include = re.compile(r'(\s*#include\s+<)(.*?\.hpp)?(>\s*)?')
+ self.re_identifier = re.compile(r'(.*?\W*)(\w+)(\W.*?)?')
+ self.re_modtime = re.compile(r'\s*modtime:\s*(.*)')
+ self.in_literal_block = 0
+ self.in_reference = 0
+
+
+ def visit_title(self, node):
+ old_len = len(self.active_visitor().body)
+ self.__super.visit_title(self, node)
+
+ self = self.active_visitor()
+ if len(self.body) - old_len > 1 and not node.has_key('refid'):
+ name = nodes.make_id(node.astext())
+ self.body[-1] = self.starttag(
+ {}, 'a', '', name=name, href='#%s' % name, CLASS='subsection-title'
+ )
+
+ def depart_title(self, node):
+ self.__super.depart_title(self, node)
+
+
+ def visit_reference(self, node):
+ self.in_reference = 1
+ if len(node) == 1 and isinstance(node[0], nodes.literal) and node[0].has_key('class'):
+ if node.has_key('class') and node['class'].find(node[0]['class']) == -1:
+ node['class'] += ' %s' % node[0]['class']
+ else:
+ node['class'] = node[0]['class']
+
+ self.__super.visit_reference(self, node)
+
+
+ def depart_reference(self, node):
+ self.__super.depart_reference(self, node)
+ self.in_reference = 0
+
+
+ def visit_literal(self, node):
+ if self.in_reference:
+ self.__super.visit_literal(self, node)
+
+ base = self
+ self = self.active_visitor()
+
+ self.body.append(self.starttag(node, 'tt', '', CLASS='literal'))
+ text = node.astext()
+
+ if base.re_include.search(text):
+ text = base.re_include.sub(lambda m: base._handle_include_sub(self, m), text)
+ self.body.append('<span class="pre">%s</span>' % text)
+ else:
+ for token in self.words_and_spaces.findall(text):
+ if token.strip():
+ if base.re_identifier.search(token):
+ token = base.re_identifier.sub(lambda m: base._handle_id_sub(self, m), token)
+ else:
+ token = self.encode(token)
+
+ self.body.append('<span class="pre">%s</span>' % token)
+ elif token in ('\n', ' '):
+ # Allow breaks at whitespace:
+ self.body.append(token)
+ else:
+ # Protect runs of multiple spaces; the last space can wrap:
+ self.body.append(' ' * (len(token) - 1) + ' ')
+
+ self.body.append('</tt>')
+ # Content already processed:
+ raise nodes.SkipNode
+
+
+ def visit_literal_block(self, node):
+ self.__super.visit_literal_block(self, node)
+ self.in_literal_block = True
+
+ def depart_literal_block(self, node):
+ self.__super.depart_literal_block(self, node)
+ self.in_literal_block = False
+
+
+ def visit_Text(self, node):
+ if not self.in_literal_block:
+ self.__super.visit_Text(self, node)
+ else:
+ base = self
+ self = self.active_visitor()
+
+ text = node.astext()
+ if base.re_include.search(text):
+ text = base.re_include.sub(lambda m: base._handle_include_sub(self, m), text)
+ elif base.re_identifier.search(text):
+ text = base.re_identifier.sub(lambda m: base._handle_id_sub(self, m), text)
+ else:
+ text = self.encode(text)
+
+ self.body.append(text)
+
+
+ def depart_Text(self, node):
+ pass
+
+
+ def visit_substitution_reference(self, node):
+ # debug help
+ print 'Unresolved substitution_reference:', node.astext()
+ raise nodes.SkipNode
+
+ def _handle_depart_page(self, translator, node):
+ pass
+
+
+ def _handle_include_sub(base, self, match):
+ if not match.group(2) or not match.group():
+ return self.encode(match.group(0))
+
+ header = match.group(2)
+ result = self.encode(match.group(1))
+ result += '%s' \
+ % ( '../../../../%s' % header
+ , self.encode(header)
+ )
+
+ result += self.encode(match.group(3))
+ return result
+
+
+ def _handle_id_sub(base, self, match):
+ identifier = match.group(2)
+ if not base.document.has_name( identifier.lower() ):
+ return self.encode(match.group(0))
+
+ result = self.encode(match.group(1))
+ result += '%s' \
+ % ( base._chunk_ref( base._active_chunk_id(), base.document.nameids[identifier.lower()] )
+ , self.encode(identifier)
+ )
+
+ if match.group(3):
+ result += self.encode(match.group(3))
+
+ return result
+
+
+class hacked_html_translator(nodes.NodeVisitor):
+
+ def __init__(self, document):
+ self.__super = nodes.NodeVisitor
+ self.__super.__init__(self, document)
+ self.base = html4css1.HTMLTranslator(document)
+ self.body = self.base.body
+ self.head = self.base.head
+ self.astext = self.base.astext
+ self.starttag = self.base.starttag
+ self.words_and_spaces = self.base.words_and_spaces
+ self.encode = self.base.encode
+ self.recursion_level = 0
+
+ def visit_section(self, node):
+ if self.base.section_level == 1:
+ self.base.section_level = 2
+
+ self.base.body_prefix = self.body_prefix
+ self.base.visit_section(node)
+
+ def depart_section(self, node):
+ self.base.depart_section(node)
+ if self.base.section_level == 2:
+ self.base.section_level = 1
+
+
+ def visit_generated(self, node):
+ if node.get('class', '') == 'sectnum':
+ node[0].data = string.strip(node[0].data, u'\u00a0')
+
+ self.base.visit_generated(node)
+
+ def depart_generated(self, node):
+ self.base.depart_generated(node)
+
+
+def _setup_forwarding(visitor):
+ for name in nodes.node_class_names:
+ if not getattr(visitor, 'visit_' + name, None):
+
+ def forward_visit(self, node, name=name):
+ self.recursion_level += 1
+ #print '%svisit_%s' % ( '+' * self.recursion_level, name )
+ getattr(self.base, 'visit_' + name)(node)
+
+ def forward_depart(self, node, name=name):
+ #print '%sdepart_%s' % ( '-' * self.recursion_level, name )
+ self.recursion_level -= 1
+ getattr(self.base, 'depart_' + name)(node)
+
+ setattr(visitor, 'visit_' + name, forward_visit)
+ setattr(visitor, 'depart_' + name, forward_depart)
+
+_setup_forwarding(hacked_html_translator)
Added: trunk/libs/mpl/doc/src/docutils/writers/html4_refdoc/frames.css
==============================================================================
--- (empty file)
+++ trunk/libs/mpl/doc/src/docutils/writers/html4_refdoc/frames.css 2008-06-17 17:46:20 EDT (Tue, 17 Jun 2008)
@@ -0,0 +1,205 @@
+/*
+Copyright Aleksey Gurtovoy 2004-2008
+
+Distributed under the Boost Software License, Version 1.0.
+(See accompanying file LICENSE_1_0.txt or copy at
+http://www.boost.org/LICENSE_1_0.txt)
+*/
+
+@import url(default.css);
+
+div.section h1
+{
+ margin-top: 0pt;
+ margin-bottom: 0pt;
+}
+
+
+div.section h3
+{
+ margin-bottom: 0pt;
+ padding-bottom: 0pt;
+
+/*
+ padding-left: 1pt;
+ border-style: none none solid none ;
+ border-width: 2px;
+ border-color: #f0a0a0;
+*/
+}
+
+p
+{
+ margin-top: 7pt;
+ padding-top: 0pt;
+}
+
+pre.literal-block
+{
+ border-style: none none none solid;
+ border-width: 1px;
+ border-color: black;
+ padding-top: 1pt;
+ padding-bottom: 1pt;
+ padding-left: 1em;
+ margin-top: 10pt;
+ margin-left: 0pt;
+ background-color: #f5f5f5;
+}
+
+td pre.literal-block
+{
+ border-style: none;
+ margin-top: 0pt;
+ padding-left: 1pt;
+}
+
+tt.literal {
+ background-color: #f5f5f5;
+}
+
+body.docframe {
+ background: #fffff5 url(manual.png) no-repeat top right fixed;
+ margin-right: 25pt;
+}
+
+/*
+span.navigation-group {
+ background-color: #f0f5ff;
+}
+*/
+
+table
+{
+ border: solid 1px;
+ border-collapse: collapse;
+}
+
+table td
+{
+ margin-top: 0pt;
+ margin-bottom: 0pt;
+ padding-top: 2pt;
+ padding-bottom: 3pt;
+}
+
+a.ref-subsection-title
+{
+ text-decoration: none;
+ color: black;
+}
+
+table.table
+{
+ border: solid 1px black;
+ border-collapse: collapse;
+}
+
+table.table td
+, table.table th
+{
+ border: solid 1px black;
+}
+
+table.wrapper
+{
+ border: 0px;
+ width: 100%;
+ margin-top: 0px;
+ margin-left: 0px;
+ margin-bottom: 0px;
+}
+
+table.wrapper td
+{
+ padding-left: 0px;
+ padding-right: 0px;
+ padding-bottom: 0px;
+ vertical-align: middle;
+}
+
+table.wrapper td.right
+{
+ padding-left: 0px;
+ text-align: right;
+}
+
+table.wrapper td.right img
+{
+ float: right;
+ border-width: 0px;
+}
+
+/*
+a:link,
+a:visited
+{
+ color: #505050;
+}
+
+sup a:link,
+sup a:visited,
+a.interlink:link,
+a.interlink:visited
+{
+ color: #505050;
+ text-decoration: none;
+}
+*/
+
+a.subsection-title
+{
+ color: black;
+ text-decoration: none;
+}
+
+ a.identifier
+,a.header
+{
+ color: black;
+ text-decoration: none;
+}
+
+ a.identifier:hover
+,a.header:hover
+{
+/* color: #0000c0;*/
+ background-color: #eeeeee;
+}
+
+
+hr.navigation-bar-separator {
+ width: 100%;
+ clear: both;
+}
+
+span.navigation-bar {
+ float: left;
+}
+
+span.page-location {
+ float: right;
+}
+
+body.tocframe ul.auto-toc,
+ul.auto-toc {
+ list-style-type: none;
+ margin-left: 0pt;
+}
+
+ul.auto-toc li li,
+body.tocframe ul.auto-toc li li {
+ list-style-type: none;
+ margin-left: 15pt;
+}
+
+body.tocframe ul.toc,
+ul.toc {
+ margin-left: 0pt;
+}
+
+body.tocframe ul.toc li,
+ul.toc li {
+ list-style-type: circle;
+ margin-left: 15pt;
+}
Modified: trunk/libs/mpl/doc/src/refmanual/AUX_LAMBDA_SUPPORT.rst
==============================================================================
--- trunk/libs/mpl/doc/src/refmanual/AUX_LAMBDA_SUPPORT.rst (original)
+++ trunk/libs/mpl/doc/src/refmanual/AUX_LAMBDA_SUPPORT.rst 2008-06-17 17:46:20 EDT (Tue, 17 Jun 2008)
@@ -102,5 +102,4 @@
|Macros|, |Metafunctions|, |Lambda Expression|
-.. |PP-tuple| replace:: `PP-tuple`__
-__ http://www.boost.org/libs/preprocessor/doc/data/tuples.html
+.. |PP-tuple| replace:: `PP-tuple <http://www.boost.org/libs/preprocessor/doc/data/tuples.html>`__
Modified: trunk/libs/mpl/doc/src/refmanual/Acknowledgements.rst
==============================================================================
--- trunk/libs/mpl/doc/src/refmanual/Acknowledgements.rst (original)
+++ trunk/libs/mpl/doc/src/refmanual/Acknowledgements.rst 2008-06-17 17:46:20 EDT (Tue, 17 Jun 2008)
@@ -1,9 +1,9 @@
-
.. Copyright Aleksey Gurtovoy, David Abrahams 2007.
.. Distributed under the Boost
.. Software License, Version 1.0. (See accompanying
.. file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+
The format and language of this reference documentation has been greatly influenced by
the SGI's `Standard Template Library Programmer's Guide`__.
Modified: trunk/libs/mpl/doc/src/refmanual/Algorithms-Iteration.rst
==============================================================================
--- trunk/libs/mpl/doc/src/refmanual/Algorithms-Iteration.rst (original)
+++ trunk/libs/mpl/doc/src/refmanual/Algorithms-Iteration.rst 2008-06-17 17:46:20 EDT (Tue, 17 Jun 2008)
@@ -1,9 +1,9 @@
-
.. Copyright Aleksey Gurtovoy, David Abrahams 2007.
.. Distributed under the Boost
.. Software License, Version 1.0. (See accompanying
.. file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+
Iteration algorithms are the basic building blocks behind many of the
MPL's algorithms, and are usually the first place to look at when
starting to build a new one. Abstracting away the details of sequence
Modified: trunk/libs/mpl/doc/src/refmanual/Algorithms-Querying.rst
==============================================================================
--- trunk/libs/mpl/doc/src/refmanual/Algorithms-Querying.rst (original)
+++ trunk/libs/mpl/doc/src/refmanual/Algorithms-Querying.rst 2008-06-17 17:46:20 EDT (Tue, 17 Jun 2008)
@@ -1,7 +1,7 @@
-
.. Copyright Aleksey Gurtovoy, David Abrahams 2007.
.. Distributed under the Boost
.. Software License, Version 1.0. (See accompanying
.. file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+
.. |Querying Algorithms| replace:: `Querying Algorithms`_
Modified: trunk/libs/mpl/doc/src/refmanual/Algorithms-Runtime.rst
==============================================================================
--- trunk/libs/mpl/doc/src/refmanual/Algorithms-Runtime.rst (original)
+++ trunk/libs/mpl/doc/src/refmanual/Algorithms-Runtime.rst 2008-06-17 17:46:20 EDT (Tue, 17 Jun 2008)
@@ -1,9 +1,9 @@
-
.. Copyright Aleksey Gurtovoy, David Abrahams 2007.
.. Distributed under the Boost
.. Software License, Version 1.0. (See accompanying
.. file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+
.. The MPL *runtime algorithms* provide out-of-box support for the
common scenarios of crossing compile time/runtime boundary.
Modified: trunk/libs/mpl/doc/src/refmanual/Algorithms-Transformation.rst
==============================================================================
--- trunk/libs/mpl/doc/src/refmanual/Algorithms-Transformation.rst (original)
+++ trunk/libs/mpl/doc/src/refmanual/Algorithms-Transformation.rst 2008-06-17 17:46:20 EDT (Tue, 17 Jun 2008)
@@ -1,9 +1,9 @@
-
.. Copyright Aleksey Gurtovoy, David Abrahams 2007.
.. Distributed under the Boost
.. Software License, Version 1.0. (See accompanying
.. file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+
According to their name, MPL's *transformation*, or *sequence-building
algorithms* provide the tools for building new sequences from the existing
ones by performing some kind of transformation. A typical transformation
Modified: trunk/libs/mpl/doc/src/refmanual/Algorithms.rst
==============================================================================
--- trunk/libs/mpl/doc/src/refmanual/Algorithms.rst (original)
+++ trunk/libs/mpl/doc/src/refmanual/Algorithms.rst 2008-06-17 17:46:20 EDT (Tue, 17 Jun 2008)
@@ -1,9 +1,9 @@
-
.. Copyright Aleksey Gurtovoy, David Abrahams 2007.
.. Distributed under the Boost
.. Software License, Version 1.0. (See accompanying
.. file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+
The MPL provides a broad range of fundamental algorithms aimed to
satisfy the majority of sequential compile-time data processing
needs. The algorithms include compile-time counterparts
@@ -40,6 +40,5 @@
concept.
-.. |Output Iterator| replace:: `Output Iterator <http://www.sgi.com/tech/stl/OutputIterator.html>`_
-.. |sequence algorithms| replace:: `sequence algorithms`__
-__ `Algorithms`_
+.. |Output Iterator| replace:: `Output Iterator <http://www.sgi.com/tech/stl/OutputIterator.html>`__
+.. |sequence algorithms| replace:: `sequence algorithms <|Algorithms link|>`__
Modified: trunk/libs/mpl/doc/src/refmanual/AssociativeSequence.rst
==============================================================================
--- trunk/libs/mpl/doc/src/refmanual/AssociativeSequence.rst (original)
+++ trunk/libs/mpl/doc/src/refmanual/AssociativeSequence.rst 2008-06-17 17:46:20 EDT (Tue, 17 Jun 2008)
@@ -114,8 +114,8 @@
|Sequences|, |Extensible Associative Sequence|, |has_key|, |count|, |order|, |at|, |key_type|, |value_type|
-.. |key| replace:: `key`__
-__ `key-part`_
+.. |key| replace:: `key <|key-part_link|>`__
+.. |key-part_link| replace:: `key-part`_
-.. |value| replace:: `value`__
-__ `value-part`_
+.. |value| replace:: `value <|value-part_link|>`__
+.. |value-part_link| replace:: `value-part`_
Modified: trunk/libs/mpl/doc/src/refmanual/CFG_NO_PREPROCESSED.rst
==============================================================================
--- trunk/libs/mpl/doc/src/refmanual/CFG_NO_PREPROCESSED.rst (original)
+++ trunk/libs/mpl/doc/src/refmanual/CFG_NO_PREPROCESSED.rst 2008-06-17 17:46:20 EDT (Tue, 17 Jun 2008)
@@ -40,5 +40,4 @@
|Macros|, |Configuration|
-.. |preprocessed headers| replace:: `preprocessed headers`__
-__ `BOOST_MPL_CFG_NO_PREPROCESSED_HEADERS`_
+.. |preprocessed headers| replace:: `preprocessed headers <|BOOST_MPL_CFG_NO_PREPROCESSED_HEADERS link|>`__
Modified: trunk/libs/mpl/doc/src/refmanual/Categorized.rst
==============================================================================
--- trunk/libs/mpl/doc/src/refmanual/Categorized.rst (original)
+++ trunk/libs/mpl/doc/src/refmanual/Categorized.rst 2008-06-17 17:46:20 EDT (Tue, 17 Jun 2008)
@@ -1,9 +1,9 @@
-
.. Copyright Aleksey Gurtovoy, David Abrahams 2007.
.. Distributed under the Boost
.. Software License, Version 1.0. (See accompanying
.. file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+
.. _`Categorized`:
Concepts
Modified: trunk/libs/mpl/doc/src/refmanual/Data.rst
==============================================================================
--- trunk/libs/mpl/doc/src/refmanual/Data.rst (original)
+++ trunk/libs/mpl/doc/src/refmanual/Data.rst 2008-06-17 17:46:20 EDT (Tue, 17 Jun 2008)
@@ -1,9 +1,9 @@
-
.. Copyright Aleksey Gurtovoy, David Abrahams 2007.
.. Distributed under the Boost
.. Software License, Version 1.0. (See accompanying
.. file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+
.. _`Data`:
.. |Data Types| replace:: `Data Types`_
Modified: trunk/libs/mpl/doc/src/refmanual/Iterators-Concepts.rst
==============================================================================
--- trunk/libs/mpl/doc/src/refmanual/Iterators-Concepts.rst (original)
+++ trunk/libs/mpl/doc/src/refmanual/Iterators-Concepts.rst 2008-06-17 17:46:20 EDT (Tue, 17 Jun 2008)
@@ -1,5 +1,4 @@
-
.. Copyright Aleksey Gurtovoy, David Abrahams 2007.
.. Distributed under the Boost
.. Software License, Version 1.0. (See accompanying
Modified: trunk/libs/mpl/doc/src/refmanual/Iterators-Metafunctions.rst
==============================================================================
--- trunk/libs/mpl/doc/src/refmanual/Iterators-Metafunctions.rst (original)
+++ trunk/libs/mpl/doc/src/refmanual/Iterators-Metafunctions.rst 2008-06-17 17:46:20 EDT (Tue, 17 Jun 2008)
@@ -1,9 +1,9 @@
-
.. Copyright Aleksey Gurtovoy, David Abrahams 2007.
.. Distributed under the Boost
.. Software License, Version 1.0. (See accompanying
.. file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+
From the implementation standpoint, iterators are almost-opaque types which
guarantee to provide us with the only memeber that we can access directly:
their category. Incrementing, dereferencing and the rest of iterator
Modified: trunk/libs/mpl/doc/src/refmanual/Iterators.rst
==============================================================================
--- trunk/libs/mpl/doc/src/refmanual/Iterators.rst (original)
+++ trunk/libs/mpl/doc/src/refmanual/Iterators.rst 2008-06-17 17:46:20 EDT (Tue, 17 Jun 2008)
@@ -1,9 +1,9 @@
-
.. Copyright Aleksey Gurtovoy, David Abrahams 2007.
.. Distributed under the Boost
.. Software License, Version 1.0. (See accompanying
.. file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+
Iterators are generic means of addressing a particular element or a range
of sequential elements in a sequence. They are also a mechanism that makes
it possible to decouple `algorithms`__ from concrete compile-time `sequence
Modified: trunk/libs/mpl/doc/src/refmanual/Macros-Asserts.rst
==============================================================================
--- trunk/libs/mpl/doc/src/refmanual/Macros-Asserts.rst (original)
+++ trunk/libs/mpl/doc/src/refmanual/Macros-Asserts.rst 2008-06-17 17:46:20 EDT (Tue, 17 Jun 2008)
@@ -1,5 +1,4 @@
-
.. Copyright Aleksey Gurtovoy, David Abrahams 2007.
.. Distributed under the Boost
.. Software License, Version 1.0. (See accompanying
Modified: trunk/libs/mpl/doc/src/refmanual/Macros-Configuration.rst
==============================================================================
--- trunk/libs/mpl/doc/src/refmanual/Macros-Configuration.rst (original)
+++ trunk/libs/mpl/doc/src/refmanual/Macros-Configuration.rst 2008-06-17 17:46:20 EDT (Tue, 17 Jun 2008)
@@ -1,7 +1,7 @@
-
.. Copyright Aleksey Gurtovoy, David Abrahams 2007.
.. Distributed under the Boost
.. Software License, Version 1.0. (See accompanying
.. file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+
.. |Configuration| replace:: `Configuration`_
Modified: trunk/libs/mpl/doc/src/refmanual/Macros.rst
==============================================================================
--- trunk/libs/mpl/doc/src/refmanual/Macros.rst (original)
+++ trunk/libs/mpl/doc/src/refmanual/Macros.rst 2008-06-17 17:46:20 EDT (Tue, 17 Jun 2008)
@@ -1,9 +1,9 @@
-
.. Copyright Aleksey Gurtovoy, David Abrahams 2007.
.. Distributed under the Boost
.. Software License, Version 1.0. (See accompanying
.. file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+
Being a *template* metaprogramming framework, the MPL concentrates on
getting one thing done well and leaves most of the clearly
preprocessor-related tasks to the corresponding specialized
Modified: trunk/libs/mpl/doc/src/refmanual/Metafunctions-Arithmetic.rst
==============================================================================
--- trunk/libs/mpl/doc/src/refmanual/Metafunctions-Arithmetic.rst (original)
+++ trunk/libs/mpl/doc/src/refmanual/Metafunctions-Arithmetic.rst 2008-06-17 17:46:20 EDT (Tue, 17 Jun 2008)
@@ -1,10 +1,8 @@
-
.. Copyright Aleksey Gurtovoy, David Abrahams 2007.
.. Distributed under the Boost
.. Software License, Version 1.0. (See accompanying
.. file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
-.. |Arithmetic Operations| replace:: `Arithmetic Operations`_
-.. |arithmetic| replace:: `arithmetic`__
-__ `Arithmetic Operations`_
+.. |Arithmetic Operations| replace:: `Arithmetic Operations`_
+.. |arithmetic| replace:: `arithmetic <|Arithmetic Operations|>`__
Modified: trunk/libs/mpl/doc/src/refmanual/Metafunctions-Bitwise.rst
==============================================================================
--- trunk/libs/mpl/doc/src/refmanual/Metafunctions-Bitwise.rst (original)
+++ trunk/libs/mpl/doc/src/refmanual/Metafunctions-Bitwise.rst 2008-06-17 17:46:20 EDT (Tue, 17 Jun 2008)
@@ -1,10 +1,8 @@
-
.. Copyright Aleksey Gurtovoy, David Abrahams 2007.
.. Distributed under the Boost
.. Software License, Version 1.0. (See accompanying
.. file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
-.. |Bitwise Operations| replace:: `Bitwise Operations`_
-.. |bitwise| replace:: `bitwise`__
-__ `Bitwise Operations`_
+.. |Bitwise Operations| replace:: `Bitwise Operations`_
+.. |bitwise| replace:: `bitwise <|Bitwise Operations|>`__
Modified: trunk/libs/mpl/doc/src/refmanual/Metafunctions-Comparisons.rst
==============================================================================
--- trunk/libs/mpl/doc/src/refmanual/Metafunctions-Comparisons.rst (original)
+++ trunk/libs/mpl/doc/src/refmanual/Metafunctions-Comparisons.rst 2008-06-17 17:46:20 EDT (Tue, 17 Jun 2008)
@@ -1,10 +1,8 @@
-
.. Copyright Aleksey Gurtovoy, David Abrahams 2007.
.. Distributed under the Boost
.. Software License, Version 1.0. (See accompanying
.. file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
-.. |Comparisons| replace:: `Comparisons`_
-.. |comparison| replace:: `comparison`__
-__ `Comparisons`_
+.. |Comparisons| replace:: `Comparisons`_
+.. |comparison| replace:: `comparison <|Comparisons|>`__
Modified: trunk/libs/mpl/doc/src/refmanual/Metafunctions-Composition.rst
==============================================================================
--- trunk/libs/mpl/doc/src/refmanual/Metafunctions-Composition.rst (original)
+++ trunk/libs/mpl/doc/src/refmanual/Metafunctions-Composition.rst 2008-06-17 17:46:20 EDT (Tue, 17 Jun 2008)
@@ -1,12 +1,9 @@
-
.. Copyright Aleksey Gurtovoy, David Abrahams 2007.
.. Distributed under the Boost
.. Software License, Version 1.0. (See accompanying
.. file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
.. |Composition and Argument Binding| replace:: `Composition and Argument Binding`_
-.. |composition| replace:: `composition`__
-.. |argument binding| replace:: `argument binding`__
-__ `Composition and Argument Binding`_
-__ `Composition and Argument Binding`_
+.. |composition| replace:: `composition <|Composition and Argument Binding link|>`__
+.. |argument binding| replace:: `argument binding <|Composition and Argument Binding link|>`__
Modified: trunk/libs/mpl/doc/src/refmanual/Metafunctions-Conditional.rst
==============================================================================
--- trunk/libs/mpl/doc/src/refmanual/Metafunctions-Conditional.rst (original)
+++ trunk/libs/mpl/doc/src/refmanual/Metafunctions-Conditional.rst 2008-06-17 17:46:20 EDT (Tue, 17 Jun 2008)
@@ -1,8 +1,7 @@
-
.. Copyright Aleksey Gurtovoy, David Abrahams 2007.
.. Distributed under the Boost
.. Software License, Version 1.0. (See accompanying
.. file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
-.. |control flow| replace:: `control flow`__
-__ `Control Flow`_
+
+.. |control flow| replace:: `control flow <|Control Flow link|>`__
Modified: trunk/libs/mpl/doc/src/refmanual/Metafunctions-Invocation.rst
==============================================================================
--- trunk/libs/mpl/doc/src/refmanual/Metafunctions-Invocation.rst (original)
+++ trunk/libs/mpl/doc/src/refmanual/Metafunctions-Invocation.rst 2008-06-17 17:46:20 EDT (Tue, 17 Jun 2008)
@@ -1,8 +1,7 @@
-
.. Copyright Aleksey Gurtovoy, David Abrahams 2007.
.. Distributed under the Boost
.. Software License, Version 1.0. (See accompanying
.. file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
-.. |invocation| replace:: `invocation`__
-__ `Invocation`_
+
+.. |invocation| replace:: `invocation <|Invocation link|>`__
Modified: trunk/libs/mpl/doc/src/refmanual/Metafunctions-Logical.rst
==============================================================================
--- trunk/libs/mpl/doc/src/refmanual/Metafunctions-Logical.rst (original)
+++ trunk/libs/mpl/doc/src/refmanual/Metafunctions-Logical.rst 2008-06-17 17:46:20 EDT (Tue, 17 Jun 2008)
@@ -1,11 +1,9 @@
-
.. Copyright Aleksey Gurtovoy, David Abrahams 2007.
.. Distributed under the Boost
.. Software License, Version 1.0. (See accompanying
.. file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
-.. |logical| replace:: `logical`__
-__ `Logical Operations`_
+.. |logical| replace:: `logical <|Logical Operations|>`__
.. |Logical Operations| replace:: `Logical Operations`_
.. |logical operations| replace:: `logical operations`_
Modified: trunk/libs/mpl/doc/src/refmanual/Metafunctions-Trivial.rst
==============================================================================
--- trunk/libs/mpl/doc/src/refmanual/Metafunctions-Trivial.rst (original)
+++ trunk/libs/mpl/doc/src/refmanual/Metafunctions-Trivial.rst 2008-06-17 17:46:20 EDT (Tue, 17 Jun 2008)
@@ -1,9 +1,9 @@
-
.. Copyright Aleksey Gurtovoy, David Abrahams 2007.
.. Distributed under the Boost
.. Software License, Version 1.0. (See accompanying
.. file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+
The MPL provides a number of |Trivial Metafunction|\ s that a nothing more than
thin wrappers for a differently-named class nested type members. While important
in the context of `in-place metafunction composition`__, these metafunctions have
@@ -23,22 +23,13 @@
In the following table, ``x`` is an arbitrary class type.
-.. |first| replace:: |``first``|__
-.. |``first``| replace:: :refentry:`first`
-
-__ `trivial-first`_
-
-.. |second| replace:: |``second``|__
-.. |``second``| replace:: :refentry:`second`
-
-__ `trivial-second`_
-
-
-.. |base| replace:: |``base``|__
-.. |``base``| replace:: :refentry:`base`
-
-__ `trivial-base`_
-
+.. |first| replace:: `:refentry:`first` <|first link|>`__
+.. |second| replace:: `:refentry:`second` <|second link|>`__
+.. |base| replace:: `:refentry:`base` <|base link|>__
+
+.. |first link| replace:: `trivial-first`_
+.. |second link| replace:: `trivial-second`_
+.. |base link| replace:: `trivial-base`_
.. _`trivial-first`:
@@ -62,5 +53,4 @@
|Metafunctions|, |Trivial Metafunction|
-.. |Trivial Metafunctions| replace:: `Trivial Metafunctions`__
-__ `Trivial`_
+.. |Trivial Metafunctions| replace:: `Trivial Metafunctions <|Trivial link|>`__
Modified: trunk/libs/mpl/doc/src/refmanual/Metafunctions-Type.rst
==============================================================================
--- trunk/libs/mpl/doc/src/refmanual/Metafunctions-Type.rst (original)
+++ trunk/libs/mpl/doc/src/refmanual/Metafunctions-Type.rst 2008-06-17 17:46:20 EDT (Tue, 17 Jun 2008)
@@ -1,8 +1,7 @@
-
.. Copyright Aleksey Gurtovoy, David Abrahams 2007.
.. Distributed under the Boost
.. Software License, Version 1.0. (See accompanying
.. file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
-.. |type selection| replace:: `type selection`__
-__ `Type Selection`_
+
+.. |type selection| replace:: `type selection <|Type Selection link|>`__
Modified: trunk/libs/mpl/doc/src/refmanual/Metafunctions.rst
==============================================================================
--- trunk/libs/mpl/doc/src/refmanual/Metafunctions.rst (original)
+++ trunk/libs/mpl/doc/src/refmanual/Metafunctions.rst 2008-06-17 17:46:20 EDT (Tue, 17 Jun 2008)
@@ -1,9 +1,9 @@
-
.. Copyright Aleksey Gurtovoy, David Abrahams 2007.
.. Distributed under the Boost
.. Software License, Version 1.0. (See accompanying
.. file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+
The MPL includes a number of predefined metafunctions that can be roughly
classified in two categories: `general purpose metafunctions`, dealing with
conditional |type selection| and higher-order metafunction |invocation|,
Modified: trunk/libs/mpl/doc/src/refmanual/Sequences-Classes.rst
==============================================================================
--- trunk/libs/mpl/doc/src/refmanual/Sequences-Classes.rst (original)
+++ trunk/libs/mpl/doc/src/refmanual/Sequences-Classes.rst 2008-06-17 17:46:20 EDT (Tue, 17 Jun 2008)
@@ -1,9 +1,9 @@
-
.. Copyright Aleksey Gurtovoy, David Abrahams 2007.
.. Distributed under the Boost
.. Software License, Version 1.0. (See accompanying
.. file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+
The MPL provides a large number of predefined general-purpose sequence
classes covering most of the typical metaprogramming needs out-of-box.
Modified: trunk/libs/mpl/doc/src/refmanual/Sequences-Concepts.rst
==============================================================================
--- trunk/libs/mpl/doc/src/refmanual/Sequences-Concepts.rst (original)
+++ trunk/libs/mpl/doc/src/refmanual/Sequences-Concepts.rst 2008-06-17 17:46:20 EDT (Tue, 17 Jun 2008)
@@ -1,9 +1,9 @@
-
.. Copyright Aleksey Gurtovoy, David Abrahams 2007.
.. Distributed under the Boost
.. Software License, Version 1.0. (See accompanying
.. file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+
The taxonomy of sequence concepts in MPL parallels the taxonomy of the MPL
|iterators|, with two additional classification dimensions:
`extensibility` and `associativeness`.
@@ -29,5 +29,4 @@
the common parts of different sequence classes' specifications.
-.. |sequence concepts| replace:: `sequence concepts`__
-__ `label-Sequences-Concepts`_
+.. |sequence concepts| replace:: `sequence concepts <|Sequences/Concepts link|>`__
Modified: trunk/libs/mpl/doc/src/refmanual/Sequences-Intrinsic.rst
==============================================================================
--- trunk/libs/mpl/doc/src/refmanual/Sequences-Intrinsic.rst (original)
+++ trunk/libs/mpl/doc/src/refmanual/Sequences-Intrinsic.rst 2008-06-17 17:46:20 EDT (Tue, 17 Jun 2008)
@@ -1,9 +1,9 @@
-
.. Copyright Aleksey Gurtovoy, David Abrahams 2007.
.. Distributed under the Boost
.. Software License, Version 1.0. (See accompanying
.. file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+
The metafunctions that form the essential interface of sequence `classes`__
documented in the corresponding |sequence concepts| are known as
*intrinsic sequence operations*. They differ from generic
Modified: trunk/libs/mpl/doc/src/refmanual/Sequences-Views.rst
==============================================================================
--- trunk/libs/mpl/doc/src/refmanual/Sequences-Views.rst (original)
+++ trunk/libs/mpl/doc/src/refmanual/Sequences-Views.rst 2008-06-17 17:46:20 EDT (Tue, 17 Jun 2008)
@@ -1,9 +1,9 @@
-
.. Copyright Aleksey Gurtovoy, David Abrahams 2007.
.. Distributed under the Boost
.. Software License, Version 1.0. (See accompanying
.. file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+
A *view* is a sequence adaptor delivering an altered presentation of
one or more underlying sequences. Views are lazy, meaning that their
elements are only computed on demand. Similarly to the short-circuit
Modified: trunk/libs/mpl/doc/src/refmanual/Sequences.rst
==============================================================================
--- trunk/libs/mpl/doc/src/refmanual/Sequences.rst (original)
+++ trunk/libs/mpl/doc/src/refmanual/Sequences.rst 2008-06-17 17:46:20 EDT (Tue, 17 Jun 2008)
@@ -1,9 +1,9 @@
-
.. Copyright Aleksey Gurtovoy, David Abrahams 2007.
.. Distributed under the Boost
.. Software License, Version 1.0. (See accompanying
.. file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+
Compile-time sequences of types are one of the basic concepts of C++
template metaprogramming. Differences in types of objects being
manipulated is the most common point of variability of similar, but
Modified: trunk/libs/mpl/doc/src/refmanual/TagDispatchedMetafunction.rst
==============================================================================
--- trunk/libs/mpl/doc/src/refmanual/TagDispatchedMetafunction.rst (original)
+++ trunk/libs/mpl/doc/src/refmanual/TagDispatchedMetafunction.rst 2008-06-17 17:46:20 EDT (Tue, 17 Jun 2008)
@@ -161,8 +161,5 @@
|Metafunction|, |Metafunction Class|, |Numeric Metafunction|
-.. |tag-metafunction| replace:: `tag metafunction`__
-__ `tag-metafunction`_
-
-.. |tag dispatched| replace:: `tag dispatched`__
-__ `Tag Dispatched Metafunction`_
+.. |tag-metafunction| replace:: `tag metafunction <|tag-metafunction link|>`__
+.. |tag dispatched| replace:: `tag dispatched <|Tag Dispatched Metafunction link|>`__
Modified: trunk/libs/mpl/doc/src/refmanual/VariadicSequence.rst
==============================================================================
--- trunk/libs/mpl/doc/src/refmanual/VariadicSequence.rst (original)
+++ trunk/libs/mpl/doc/src/refmanual/VariadicSequence.rst 2008-06-17 17:46:20 EDT (Tue, 17 Jun 2008)
@@ -113,11 +113,7 @@
|Sequences|, |Configuration|, |Integral Sequence Wrapper|
-.. |variadic| replace:: `variadic`__
-__ `Variadic Sequence`_
-
-.. |variadic forms| replace:: `variadic forms`__
-__ `Variadic Sequence`_
-
-.. |numbered forms| replace:: `numbered forms`__
-__ `Variadic Sequence`_
+.. |variadic| replace:: `variadic <|Variadic Sequence link|>`__
+.. |variadic forms| replace:: `variadic forms <|Variadic Sequence link|>`__
+.. |numbered forms| replace:: `numbered forms <|Variadic Sequence link|>`__
+.. |Variadic Sequence link| replace:: `Variadic Sequence`_
Modified: trunk/libs/mpl/doc/src/refmanual/bool_.rst
==============================================================================
--- trunk/libs/mpl/doc/src/refmanual/bool_.rst (original)
+++ trunk/libs/mpl/doc/src/refmanual/bool_.rst 2008-06-17 17:46:20 EDT (Tue, 17 Jun 2008)
@@ -88,10 +88,5 @@
|Data Types|, |Integral Constant|, |int_|, |long_|, |integral_c|
-.. |true_| replace:: |``true_``|__
-.. |``true_``| replace:: ``true_``
-__ `bool\_`_
-
-.. |false_| replace:: |``false_``|__
-.. |``false_``| replace:: ``false_``
-__ `bool\_`_
+.. |true_| replace:: ```true_`` <|bool_ link|>`__
+.. |false_| replace:: ```false_`` <|bool_ link|>`__
Modified: trunk/libs/mpl/doc/src/refmanual/for_each.rst
==============================================================================
--- trunk/libs/mpl/doc/src/refmanual/for_each.rst (original)
+++ trunk/libs/mpl/doc/src/refmanual/for_each.rst 2008-06-17 17:46:20 EDT (Tue, 17 Jun 2008)
@@ -141,5 +141,5 @@
|Runtime Algorithms|, |Views|, |transform_view|
-.. |unary function object| replace:: `unary function object <http://www.sgi.com/tech/stl/UnaryFunction.html>`_
-.. |value_initialized| replace:: `value_initialized <http://www.boost.org/libs/utility/value_init.htm>`_
+.. |unary function object| replace:: `unary function object <http://www.sgi.com/tech/stl/UnaryFunction.html>`__
+.. |value_initialized| replace:: `value_initialized <http://www.boost.org/libs/utility/value_init.htm>`__
Modified: trunk/libs/mpl/doc/src/refmanual/inserter_.rst
==============================================================================
--- trunk/libs/mpl/doc/src/refmanual/inserter_.rst (original)
+++ trunk/libs/mpl/doc/src/refmanual/inserter_.rst 2008-06-17 17:46:20 EDT (Tue, 17 Jun 2008)
@@ -101,6 +101,4 @@
.. |+inserter+| replace:: inserter
-.. |inserter| replace:: |``inserter``|__
-.. |``inserter``| replace:: :refentry:`inserter`
-__ `inserter_`_
+.. |inserter| replace:: ':refentry:`inserter` <|inserter_ link|>'__
Modified: trunk/libs/mpl/doc/src/refmanual/refmanual.py
==============================================================================
--- trunk/libs/mpl/doc/src/refmanual/refmanual.py (original)
+++ trunk/libs/mpl/doc/src/refmanual/refmanual.py 2008-06-17 17:46:20 EDT (Tue, 17 Jun 2008)
@@ -20,7 +20,8 @@
underline = underlines[len(parts) - 1] * len(parts[-1])
if len(parts) > 0:
hidden_target = '.. _`label-%s`:' % '-'.join( parts )
- return '\n%s\n%s\n%s\n\n' % (parts[-1], underline, hidden_target )
+ replacement_link = '.. |%s link| replace:: `label-%s`_' % ( '/'.join( parts ), '-'.join( parts ) )
+ return '\n%s\n%s\n%s\n%s\n\n' % (parts[-1], underline, hidden_target, replacement_link )
else:
return '\n%s\n%s\n\n' % (parts[-1], underline )
@@ -39,9 +40,10 @@
else: ref = '/'.join( page.split('.')[0].split('-') )
if ref.upper() == ref or ref.lower() == ref:
output.write(
- ( '.. |%(ref)s| replace:: |``%(ref)s``|__\n'
- + '.. |``%(ref)s``| replace:: :refentry:`%(ref)s`\n'
- + '__ `%(ref)s`_\n' )
+ ( '.. |%(ref)s| replace:: `|%(ref)s refentry| <|%(ref)s link|>`__\n'
+ + '.. |%(ref)s refentry| replace:: :refentry:`%(ref)s`\n'
+ + '.. |%(ref)s link| replace:: `%(ref)s`_\n'
+ )
% { 'ref': ref }
)
else:
Modified: trunk/libs/mpl/doc/src/refmanual/refmanual.rst
==============================================================================
--- trunk/libs/mpl/doc/src/refmanual/refmanual.rst (original)
+++ trunk/libs/mpl/doc/src/refmanual/refmanual.rst 2008-06-17 17:46:20 EDT (Tue, 17 Jun 2008)
@@ -1,9 +1,9 @@
-
.. Copyright Aleksey Gurtovoy, David Abrahams 2007.
.. Distributed under the Boost
.. Software License, Version 1.0. (See accompanying
.. file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+
The MPL Reference Manual
************************
@@ -29,11 +29,8 @@
.. contents:: Table of Contents
:depth: 3
-.. |Boost.Bind| replace:: `Boost.Bind`__
-__ http://www.boost.org/libs/bind/bind.html
-
-.. |Boost.Lambda| replace:: `Boost.Lambda`__
-__ http://www.boost.org/libs/lambda/doc/index.html
+.. |Boost.Bind| replace:: `Boost.Bind <http://www.boost.org/libs/bind/bind.html>`__
+.. |Boost.Lambda| replace:: `Boost.Lambda <http://www.boost.org/libs/lambda/doc/index.html>`__
.. role:: refentry(literal)
@@ -87,24 +84,19 @@
.. |O(1)| replace:: *O(1)*
-.. |_1| replace:: |``_1``|__
-.. |_2| replace:: |``_2``|__
-.. |_3| replace:: |``_3``|__
-.. |_4| replace:: |``_4``|__
-.. |_5| replace:: |``_5``|__
-.. |``_1``| replace:: :refentry:`_1`
-.. |``_2``| replace:: :refentry:`_2`
-.. |``_3``| replace:: :refentry:`_3`
-.. |``_4``| replace:: :refentry:`_4`
-.. |``_5``| replace:: :refentry:`_5`
-__ `Placeholders`_
-__ `Placeholders`_
-__ `Placeholders`_
-__ `Placeholders`_
-__ `Placeholders`_
+.. |_1| replace:: `|_1 refentry| <|Placeholders|>`__
+.. |_2| replace:: `|_2 refentry| <|Placeholders|>`__
+.. |_3| replace:: `|_3 refentry| <|Placeholders|>`__
+.. |_4| replace:: `|_4 refentry| <|Placeholders|>`__
+.. |_5| replace:: `|_5 refentry| <|Placeholders|>`__
+
+.. |_1 refentry| replace:: :refentry:`_1`
+.. |_2 refentry| replace:: :refentry:`_2`
+.. |_3 refentry| replace:: :refentry:`_3`
+.. |_4 refentry| replace:: :refentry:`_4`
+.. |_5 refentry| replace:: :refentry:`_5`
-.. |placeholder| replace:: `placeholder`__
-__ `Placeholders`_
+.. |placeholder| replace:: `placeholder <|Placeholders|>`__
.. |_1,_2,..._n| replace:: |_1|, |_2|, |_3|,\ |...|
@@ -130,12 +122,12 @@
.. |preprocessed headers disclaimer| replace:: [*Note:* Overriding will take effect
- *only* if the library is configured not to use `preprocessed headers`__. See
- |+BOOST_MPL_CFG_NO_PREPROCESSED_HEADERS+|__ for more information. |--| *end note*\]
+ *only* if the library is configured not to use `preprocessed headers
+ <|BOOST_MPL_CFG_NO_PREPROCESSED_HEADERS_link|>`__. See
+ |BOOST_MPL_CFG_NO_PREPROCESSED_HEADERS_ref| for more information. |--| *end note*\]
-.. |+BOOST_MPL_CFG_NO_PREPROCESSED_HEADERS+| replace:: :refentry:`BOOST_MPL_CFG_NO_PREPROCESSED_HEADERS`
-__ `BOOST_MPL_CFG_NO_PREPROCESSED_HEADERS`_
-__ `BOOST_MPL_CFG_NO_PREPROCESSED_HEADERS`_
+.. |BOOST_MPL_CFG_NO_PREPROCESSED_HEADERS_ref| replace:: `:refentry:`BOOST_MPL_CFG_NO_PREPROCESSED_HEADERS` <|BOOST_MPL_CFG_NO_PREPROCESSED_HEADERS_link|>`__
+.. |BOOST_MPL_CFG_NO_PREPROCESSED_HEADERS_link| replace:: `BOOST_MPL_CFG_NO_PREPROCESSED_HEADERS`_
.. |transformation algorithm disclaimer| replace::
Modified: trunk/libs/mpl/doc/src/refmanual/terminology.rst
==============================================================================
--- trunk/libs/mpl/doc/src/refmanual/terminology.rst (original)
+++ trunk/libs/mpl/doc/src/refmanual/terminology.rst 2008-06-17 17:46:20 EDT (Tue, 17 Jun 2008)
@@ -1,10 +1,11 @@
-
.. Copyright Aleksey Gurtovoy, David Abrahams 2007.
.. Distributed under the Boost
.. Software License, Version 1.0. (See accompanying
.. file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+
.. _`Overloaded name`:
+.. |Overloaded name link| replace:: `Overloaded name`_
Overloaded name
Overloaded name is a term used in this reference documentation to designate
@@ -13,12 +14,11 @@
is implemented by other, unspecified, means.
-.. |overloaded name| replace:: `overloaded name`__
-__ `Overloaded name`_
-
+.. |overloaded name| replace:: `overloaded name <|Overloaded name link|>`__
.. _`Concept-identical`:
+.. |Concept-identical link| replace:: `Concept-identical`_
Concept-identical
A sequence ``s1`` is said to be concept-identical to a sequence ``s2`` if
@@ -26,6 +26,7 @@
.. _`Bind expression`:
+.. |Bind expression link| replace:: `Bind expression`_
Bind expression
A bind expression is simply that |--| an instantiation of one of the |bind|
@@ -42,12 +43,5 @@
_2
-.. |bind expression| replace:: `bind expression`__
-__ `Bind expression`_
-
-
-
-.. |concept-identical| replace:: `concept-identical`__
-__ `Concept-identical`_
-
-
+.. |bind expression| replace:: `bind expression <|Bind expression link|>`__
+.. |concept-identical| replace:: `concept-identical <|Concept-identical link|>`__
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