Skip to content

Commit

Permalink
Merge fdd7bc2 into 2860587
Browse files Browse the repository at this point in the history
  • Loading branch information
jbednar committed Aug 20, 2020
2 parents 2860587 + fdd7bc2 commit 557b732
Show file tree
Hide file tree
Showing 29 changed files with 2,552 additions and 335 deletions.
4 changes: 2 additions & 2 deletions .travis.yml
Expand Up @@ -132,8 +132,8 @@ jobs:
- pip install -e .
script:
# TODO: nbsite commands will be simplified eventually...
- nbsite generate-rst --org pyviz --repo param --project-name param
- mkdir doc/Reference_Manual && nbsite_generate_modules.py param -d ./doc/Reference_Manual -n param -e tests
- nbsite generate-rst --org holoviz --repo param --project-name param
- mkdir -p doc/Reference_Manual && nbsite_generate_modules.py param -d ./doc/Reference_Manual -n param -e tests
- nbsite build --examples-assets=''
deploy:
- provider: pages
Expand Down
97 changes: 97 additions & 0 deletions doc/Reference_Manual/index.rst
@@ -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 modified doc/_static/favicon.ico 100755 → 100644
Binary file not shown.
Binary file added doc/_static/icon.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 557b732

Please sign in to comment.