SiegfriedSiegert/PTU5KAS
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Update devguide to handle new plugin structure

Browse Source 
* Add plugins module to the class reference documentation.

* Drop documentation of member classes and functions within plugins as
  the these aren't intended to be called directly outside of the plugin
  class itself.

Signed-off-by: Paul Barker <pbarker@konsulko.com>
Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
This commit is contained in:
Paul Barker 2020-11-06 12:50:15 +01:00 committed by Jan Kiszka
parent c3e1594b0e
commit f69311b18b
1 changed files with 5 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/devguide.rst
View File

@ -78,18 +78,6 @@ Class reference documentation
.. automodule:: kas.libcmds .. automodule:: kas.libcmds
:members: :members:
``kas.build`` Module
....................
.. automodule:: kas.build
:members:
``kas.shell`` Module
....................
.. automodule:: kas.shell
:members:
``kas.config`` Module ``kas.config`` Module
..................... .....................
@ -108,3 +96,8 @@ Class reference documentation
.. automodule:: kas.includehandler .. automodule:: kas.includehandler
:members: :members:
``kas.plugins`` Module
......................
.. automodule:: kas.plugins
:members: