diff options
| author | goodger <goodger@929543f6-e4f2-0310-98a6-ba3bd3dd1d04> | 2004-06-27 20:50:54 +0000 |
|---|---|---|
| committer | goodger <goodger@929543f6-e4f2-0310-98a6-ba3bd3dd1d04> | 2004-06-27 20:50:54 +0000 |
| commit | d034202bedfbd439215f3feced627142d86c7928 (patch) | |
| tree | 99833994dee51b24c93cbdf0f836e688b70a8791 /docs/api | |
| parent | e001aacf90267adb95c3ba197fc13d8dd39a5d0f (diff) | |
| download | docutils-d034202bedfbd439215f3feced627142d86c7928.tar.gz | |
updated
git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk/docutils@2402 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
Diffstat (limited to 'docs/api')
| -rw-r--r-- | docs/api/runtime-settings.txt | 13 |
1 files changed, 9 insertions, 4 deletions
diff --git a/docs/api/runtime-settings.txt b/docs/api/runtime-settings.txt index 110b1b2f9..b66009726 100644 --- a/docs/api/runtime-settings.txt +++ b/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)`` |