Commit 5e8ee4d8 authored by Duggan, John's avatar Duggan, John
Browse files

Update docs

parent 26541377

docs/api.rst

+12 −0
Original line number Diff line number Diff line
@@ -44,6 +44,18 @@ View Components 
    :members:

    :special-members: __init__



.. autoclass:: nova.trame.view.components.ExecutionButtons

    :members:

    :special-members: __init__



.. autoclass:: nova.trame.view.components.ProgressBar

    :members:

    :special-members: __init__



.. autoclass:: nova.trame.view.components.ToolOutputWindows

    :members:

    :special-members: __init__



.. _api_interactive2dplot:



.. autoclass:: nova.trame.view.components.visualization.Interactive2DPlot

src/nova/trame/view/components/__init__.py

+12 −1
Original line number Diff line number Diff line 
from .data_selector import DataSelector

from .execution_buttons import ExecutionButtons

from .file_upload import FileUpload

from .input_field import InputField

from .progress_bar import ProgressBar

from .remote_file_input import RemoteFileInput

from .tool_outputs import ToolOutputWindows



__all__ = ["DataSelector", "FileUpload", "InputField", "RemoteFileInput"]
 
__all__ = [

    "DataSelector",

    "ExecutionButtons",

    "FileUpload",

    "InputField",

    "ProgressBar",

    "RemoteFileInput",

    "ToolOutputWindows",

]

src/nova/trame/view/components/execution_buttons.py

+5 −2
Original line number Diff line number Diff line
@@ -10,7 +10,10 @@ from nova.trame.view_model.execution_buttons import ExecutionButtonsViewModel 




class ExecutionButtons:

    """Execution buttons class. Adds Run/Stop/Cancel/Download buttons to the view."""

    """Execution buttons class. Adds Run/Stop/Cancel/Download buttons to the view.



    This is intended to be used with the `nova-galaxy ToolRunner <https://nova-application-development.readthedocs.io/projects/nova-galaxy/en/latest/core_concepts/tool_runner.html>`__.

    """



    def __init__(self, id: str, stop_btn: bool = False, download_btn: bool = False) -> None:

        """Constructor for ExecutionButtons.
@@ -18,7 +21,7 @@ class ExecutionButtons: 
        Parameters

        ----------

        id : str

            Component id. Should be used consistently with ToolRunner and other components

            Component id. Should be used consistently with ToolRunner and other components.

        stop_btn: bool

            Display stop button.

        download_btn : bool

src/nova/trame/view/components/progress_bar.py

+4 −1
Original line number Diff line number Diff line
@@ -9,7 +9,10 @@ from nova.trame.view_model.progress_bar import ProgressBarViewModel 




class ProgressBar:

    """Progress bar class. Adds progress bar that displays job status to the view."""

    """Progress bar class. Adds progress bar that displays job status to the view.



    This is intended to be used with the `nova-galaxy ToolRunner <https://nova-application-development.readthedocs.io/projects/nova-galaxy/en/latest/core_concepts/tool_runner.html>`__.

    """



    def __init__(self, id: str) -> None:

        """Constructor for ProgressBar.

src/nova/trame/view/components/tool_outputs.py

+4 −1
Original line number Diff line number Diff line
@@ -10,7 +10,10 @@ from nova.trame.view_model.tool_outputs import ToolOutputsViewModel 




class ToolOutputWindows:

    """Tool outputs class. Displays windows with tool stdout/stderr."""

    """Tool outputs class. Displays windows with tool stdout/stderr.



    This is intended to be used with the `nova-galaxy ToolRunner <https://nova-application-development.readthedocs.io/projects/nova-galaxy/en/latest/core_concepts/tool_runner.html>`__.

    """



    def __init__(self, id: str) -> None:

        """Constructor for ToolOutputWindows.