[Checkins] SVN: manuel/trunk/src/ break out the "Included Functionality" section into its own file
Benji York
benji at zope.com
Mon Jun 22 19:24:27 EDT 2009
Log message for revision 101237:
break out the "Included Functionality" section into its own file
Changed:
A manuel/trunk/src/functionality.txt
U manuel/trunk/src/index.txt
U manuel/trunk/src/intro.txt
-=-
Copied: manuel/trunk/src/functionality.txt (from rev 101236, manuel/trunk/src/intro.txt)
===================================================================
--- manuel/trunk/src/functionality.txt (rev 0)
+++ manuel/trunk/src/functionality.txt 2009-06-22 23:24:26 UTC (rev 101237)
@@ -0,0 +1,25 @@
+.. _functionality:
+
+Included Functionality
+======================
+
+Manuel includes several plug-ins out of the box:
+
+:ref:`manuel.capture <capture>`
+ stores regions of a document in variables for later processing
+
+:ref:`manuel.codeblock <code-blocks>`
+ executes code in ".. code-block:: python" blocks
+
+:ref:`manuel.doctest <doctest>`
+ provides traditional doctest processing as a Manuel plug-in
+
+:ref:`manuel.footnote <footnotes>`
+ executes code in reST-style footnodes each time they're referenced (good
+ for getting incedental code out of the main flow of a document)
+
+:ref:`manuel.ignore <ignore>`
+ ignores parts of a document while running tests
+
+:ref:`manuel.isolation <isolation>`
+ makes it easier to have test isolation in doctests
Property changes on: manuel/trunk/src/functionality.txt
___________________________________________________________________
Added: svn:mergeinfo
+
Added: svn:eol-style
+ native
Modified: manuel/trunk/src/index.txt
===================================================================
--- manuel/trunk/src/index.txt 2009-06-22 22:48:38 UTC (rev 101236)
+++ manuel/trunk/src/index.txt 2009-06-22 23:24:26 UTC (rev 101237)
@@ -7,6 +7,7 @@
:numbered:
intro.txt
+ functionality.txt
getting-started.txt
manuel/capture.txt
manuel/codeblock.txt
Modified: manuel/trunk/src/intro.txt
===================================================================
--- manuel/trunk/src/intro.txt 2009-06-22 22:48:38 UTC (rev 101236)
+++ manuel/trunk/src/intro.txt 2009-06-22 23:24:26 UTC (rev 101237)
@@ -4,7 +4,7 @@
Manuel lets you mix and match traditional doctests with custom test syntax.
Several plug-ins are included that provide new test syntax (see
-:ref:`included-functionality`). You can create your own plug-ins as well.
+:ref:`functionality`). You can create your own plug-ins as well.
For example, if you've ever wanted to include a large chunk of Python in a
doctest but were irritated by all the ">>>" and "..." prompts required, you'd
@@ -23,35 +23,10 @@
code.
The plug-ins included in Manuel make good examples while being quite useful in
-their own right. All the included plug-ins are listed in the next section.
+their own right. The Manuel documentation makes extensive use of them as well.
+All the included plug-ins are listed in the :ref:`next section <functionality>`.
For a large example of creating test syntax, take a look at the
:ref:`fit-table-example` or for all the details, :ref:`theory-of-operation`.
To see how to get Manuel wired up see the :ref:`getting-started` section.
-
-.. _included-functionality:
-
-Included Functionality
-======================
-
-Manuel includes quite a bit of functionality out of the box:
-
-:ref:`manuel.capture <capture>`
- stores regions of a document in variables for later processing
-
-:ref:`manuel.codeblock <code-blocks>`
- executes code in ".. code-block:: python" blocks
-
-:ref:`manuel.doctest <doctest>`
- provides traditional doctest processing as a Manuel plug-in
-
-:ref:`manuel.footnote <footnotes>`
- executes code in reST-style footnodes each time they're referenced (good
- for getting incedental code out of the main flow of a document)
-
-:ref:`manuel.ignore <ignore>`
- ignores parts of a document while running tests
-
-:ref:`manuel.isolation <isolation>`
- makes it easier to have test isolation in doctests
More information about the Checkins
mailing list