Rev. 5894 includes a draft of the new section of writingPlugins.txt
titled Documenting Plugins. It's reproduced here:
QQQ
Documenting new plugins is important for users to be able understand and
use the features they add. To that effect, there are a few
documentation steps that should not be overlooked.
- Document the plugin thoroughly in the plugin's docstring. This allows
the documentation to be accessed from the Plugins menu.
- Document any new commands with a proper docstring. This allows the
minibuffer command `help-for-command` to provide help for the command.
- In `leo/doc/sphinx-docs/sphinxDocs.leo`, to the node `@file
leo.plugins.rst`, add the following snippet (preferably in alphabetical
order), with the name of the plugin modified to the name of your plugin
(here `ipython`). This allows the API docs to be automatically updated. ::
:mod:`ipython` Module
---------------------
.. automodule:: leo.plugins.ipython
:members:
:undoc-members:
:show-inheritance:
QQQ
This is missing information on Terry's documentation extraction script,
which I've yet to get a handle on.
Any comments/suggestions/etc.?
-->Jake
--
You received this message because you are subscribed to the Google Groups
"leo-editor" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
Visit this group at http://groups.google.com/group/leo-editor.
For more options, visit https://groups.google.com/groups/opt_out.
