summaryrefslogtreecommitdiff
path: root/docutils/docs/api
diff options
context:
space:
mode:
authorgoodger <goodger@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2004-06-27 20:50:54 +0000
committergoodger <goodger@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2004-06-27 20:50:54 +0000
commit73131ae92254d9f36ddc2a9845ca55be9c2013e5 (patch)
tree28a841de5dd8319397610c79164901356101e266 /docutils/docs/api
parent4d281a215e5984102ae556ad7cb2e58780f1ec06 (diff)
downloaddocutils-73131ae92254d9f36ddc2a9845ca55be9c2013e5.tar.gz
updated
git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@2402 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
Diffstat (limited to 'docutils/docs/api')
-rw-r--r--docutils/docs/api/runtime-settings.txt13
1 files changed, 9 insertions, 4 deletions
diff --git a/docutils/docs/api/runtime-settings.txt b/docutils/docs/api/runtime-settings.txt
index 110b1b2f9..b66009726 100644
--- a/docutils/docs/api/runtime-settings.txt
+++ b/docutils/docs/api/runtime-settings.txt
@@ -55,6 +55,10 @@ docstring):
Runtime Settings Processing for Command-Line Tools
==================================================
+Following allong with the actual code is recommended. The
+``docutils/__init__.py``, ``docutils/core.py``, and
+``docutils.frontend`` modules are described.
+
1. A command-line front-end tool imports and calls
``docutils.core.publish_cmdline``. The relevant `convenience
function parameters`_ are described above.
@@ -67,7 +71,7 @@ Runtime Settings Processing for Command-Line Tools
its ``settings`` attribute to see if it's defined. If it is, no
further runtime settings processing is done.
- If no ``settings`` is defined, ``self.process_command_line`` is
+ If ``settings`` is not defined, ``self.process_command_line`` is
called with the following relevant arguments:
* ``settings_spec``
@@ -81,9 +85,10 @@ Runtime Settings Processing for Command-Line Tools
5. ``self.setup_option_parser`` checks its ``config_section``
parameter; if defined, it adds that config file section to
``settings_spec`` (or to a new, empty ``docutils.SettingsSpec``
- object), replacing anything defined earlier. Then it instantiates
- a new ``docutils.frontend.OptionParser`` object, passing the
- following relevant arguments:
+ object), replacing anything defined earlier. (See `Docutils
+ Configuration Files`_ for details.) Then it instantiates a new
+ ``docutils.frontend.OptionParser`` object, passing the following
+ relevant arguments:
* ``components``: A tuple of ``docutils.SettingsSpec`` objects,
``(self.parser, self.reader, self.writer, settings_spec)``