diff --git a/docs/conf.py b/docs/conf.py index c0b8d80..e60b4a6 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -62,4 +62,5 @@ html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] \ No newline at end of file +html_static_path = ['_static'] +master_doc = 'index' diff --git a/docs/existing.rst b/docs/existing.rst new file mode 100644 index 0000000..057fbaa --- /dev/null +++ b/docs/existing.rst @@ -0,0 +1,41 @@ +.. _existing: + +================ +Existing Pluings +================ + +The isSynced plugin was designed as an extention of the ``eth_syncing`` available on statdard Geth. ``plugeth_isSynced`` was desinged to return a status object such that a status report could be given as to the current state of the node as opposed to ``eth_syncing`` which returns the status object only if the node is actively syncing and a simple false if frozen or fully synced. + + +Usage +====== +As with all ``rpc`` methods, isSynced is available by ``curl`` or the `javascript console`_. + +From the command line: + +``{"method": "plugeth_isSynced", "params": []}`` + + + +``Lookup(name string, validate func(interface{}) bool) []interface{}`` + +Returns a list of values from plugins identified by ``name``, which match the +provided ``validate`` predicate. For example: + + +.. code-block:: go + + pl.Lookup("Version", func(item interface{}) bool { + _, ok := item.(int) + return ok + }) + +Would return a list of ``int`` objects named ``Version`` in any loaded plugins. +This can enable Plugins to interact with each other, accessing values and +functions implemented in other plugins. + +GetFeed +======= +``GetFeed() Feed`` + +.. _javascript console: https://geth.ethereum.org/docs/interface/javascript-console \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index 98ed311..d6a573a 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -43,6 +43,7 @@ Table of Contents :maxdepth: 1 :caption: Reference + existing system_req version api diff --git a/docs/types.rst b/docs/types.rst index df250d6..b77c82c 100644 --- a/docs/types.rst +++ b/docs/types.rst @@ -11,6 +11,9 @@ While PluGeth has been designed to be versatile and customizable, when learning RPC Methods ----------- +this is a big ole test + + These plugins provide new json rpc methods to access several objects containing real time and historic data.