const classcamPythonPlugin::PythonDocs

sys::Obj
  camPythonPlugin::PythonDocs : camembert::PluginDocs

PythonDocs : Provides help pane documentation for Python

_docs

Source

const AtomicRef _docs := AtomicRef.<ctor>()

clearIndex

Source

Void clearIndex()

dis

Source

virtual override Str dis()

User friendly dsplay name

findSrc

Source

virtual override FileItem? findSrc(Str query)

Return a FileItem for the document matching the current source file (if known) Query wil be what's in the helPane serach box, ie "fwt::Combo#make" (not prefixed by plugin name)

html

Source

virtual override Str html(WebReq req, Str query, MatchKind matchKind)

Return html for a given path Note, the query will be prefixed with the plugin name for example /fantom/fwt::Button

icon

Source

virtual const override Image? icon := ...

index

Source

Str index(Str:PythonDoc docs)

Return python index (modules)

isIndexing

Source

const AtomicRef isIndexing := AtomicRef.<ctor>(((Obj?)false))

pluginName

Source

virtual override Str pluginName()

name of the plugin responsible

reindex

Source

Void reindex()

Index the docs for the current python env only reindex if we don't have it generated yet for the current env use clearIndex first to force reindexing

scan

Source

Str:PythonDoc scan(Obj? obj)

Read json genarted from python and create in memory doc map from it.