-
-
Notifications
You must be signed in to change notification settings - Fork 73
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
30 changed files
with
2,574 additions
and
335 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,97 @@ | ||
******************** | ||
API Reference Manual | ||
******************** | ||
|
||
The Param API Reference Manual provides a comprehensive reference for | ||
all methods and objects available from Param. For human-readable guides to | ||
how to use these capabilities, see the `User Guide <../user_guide>`_. | ||
|
||
Module Structure | ||
________________ | ||
|
||
|
||
`param package <#param-package>`_ | ||
Collection of Parameter objects to use in your code | ||
`param.parameterized module <#parameterized-module>`_ | ||
Definition for core Param components: Parameter and Parameterized, plus utilities | ||
`param.serializer module <#serializer-module>`_ | ||
Optional support for serializing to JSON or other formats | ||
`param.ipython module <#ipython-module>`_ | ||
Optional ipython support | ||
`numbergen package <#numbergen-numbergen-package>`_ | ||
Separate package with generators for streams of numeric values | ||
|
||
|
||
--------- | ||
|
||
:mod:`param` Package | ||
-------------------- | ||
|
||
.. inheritance-diagram:: param.__init__ | ||
|
||
|
||
.. automodule:: param.__init__ | ||
:members: | ||
:inherited-members: | ||
:show-inheritance: | ||
|
||
------- | ||
|
||
:mod:`parameterized` Module | ||
--------------------------- | ||
|
||
.. inheritance-diagram:: param.parameterized | ||
|
||
|
||
.. automodule:: param.parameterized | ||
:members: | ||
:inherited-members: | ||
:show-inheritance: | ||
|
||
------- | ||
|
||
:mod:`serializer` Module | ||
------------------------ | ||
|
||
.. inheritance-diagram:: param.serializer | ||
|
||
|
||
.. automodule:: param.serializer | ||
:members: | ||
:inherited-members: | ||
:show-inheritance: | ||
|
||
------- | ||
|
||
:mod:`ipython` Module | ||
--------------------- | ||
|
||
.. inheritance-diagram:: param.ipython | ||
|
||
|
||
.. automodule:: param.ipython | ||
:members: | ||
:inherited-members: | ||
:show-inheritance: | ||
|
||
------- | ||
|
||
|
||
|
||
:mod:`numbergen` Package | ||
------------------------ | ||
|
||
.. inheritance-diagram:: numbergen.__init__ | ||
|
||
|
||
.. automodule:: numbergen.__init__ | ||
:members: | ||
:inherited-members: | ||
:show-inheritance: | ||
|
||
------- | ||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
:hidden: | ||
|
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.