On Nov 11, 8:36 pm, "Edward K. Ream" <[email protected]> wrote:
> The script finds all docstrings in leoPlugins.leo. It was
> inspired by Terry's plugin_catelog.py program. It opens
> leoPlugins.leo, finds the top-level Plugins nodes, then in the
> LeoDocs.leo outline creates a tree mirroring the structure of the
> Plugins node in leoPlugins.leo, with each node containing just the
> docstring of the plugin. I'll use this script to update docs in
> LeoDocs.leo.
I have spent all day going back and forth between LeoDocs.leo and
leoPlugins.leo. As of rev 3689 of the trunk, the script looks
complete and all docstrings look good when previewed. Also, the first
paragraph (usually one sentence) of each docstring becomes the summary
of the plugin in an introductory alphabetically-organized summary
section, just as in Terry's script.
It's been a lot of work, but certainly worthwhile. For the first time
there is an easy, automated way of managing the documentation of
plugins.
For example, there are now two sets of "suppression lists" in the
script. Here are the suppressed top-level nodes in leoPlugins.leo:
'Examples','Experimental',
'Dyna plugins by e',
'Gui plugins','Testing',
No plugins from these trees will appear in the docs.
Similarly, here are the suppressed files, with the reasons why the
files are not included:
'@file bookmarks.py', # Replaced by better @url.
'@file rst3.py', # Replaced by core rst3 command.
'@file testnode.py', # Replaced by @edit.
# These all depend on old plugins_manager.py.
'@file autotrees.py',
'@file old_plugin_manager.py',
'@file leoupdate.py', # Depends on old plugins_manager.py.
# These are used only by autotrees.py.
r'@file trees\doc.py',
r'@file trees\news.py',
r'@file trees\remote.py',
r'@file trees\rss.py',
r'@file trees\test.py',
As with unit tests, these lists are much more reliable than my memory
and they are an explicit, permanent record of what is intended.
Tomorrow I will finish the last documentation tasks, including folding
the data created by the script into the Plugins chapter. We shall
then be ready to release rc1.
Edward
--
You received this message because you are subscribed to the Google Groups
"leo-editor" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/leo-editor?hl=en.
