Skip to content

Commit

Permalink
Finally figured out the sphinx bug -- autodoc is failing when there a…
Browse files Browse the repository at this point in the history
…re import statements. Commented them out
  • Loading branch information
rickmcgeer committed May 13, 2021
1 parent dd30180 commit 84ca1d6
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 33 deletions.
8 changes: 4 additions & 4 deletions source/galyleo/galyleo_jupyterlab_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,10 @@
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

from ipykernel.comm import Comm
from galyleo.galyleo_table import GalyleoTable
from galyleo.galyleo_exceptions import DataSizeExceeded
from galyleo.galyleo_constants import MAX_DATA_SIZE, MAX_TABLE_ROWS
# from ipykernel.comm import Comm
# from galyleo.galyleo_table import GalyleoTable
# from galyleo.galyleo_exceptions import DataSizeExceeded
# from galyleo.galyleo_constants import MAX_DATA_SIZE, MAX_TABLE_ROWS

""" Module for communicating between the kernel and the dashboard, through the standard 0MQ mechanism"""

Expand Down
30 changes: 2 additions & 28 deletions source/galyleoclient.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@ The Galyleo Python client is a module designed to convert Python structures into
- galyleo.galyleo_jupyterlab_client: classes and methods to send Galyleo Tables to Galyleo dashboards runniung under JupyterLab clients
- galyleo.galyleo_constants: Symbolic constants used by these packages and the code which uses them
- galyleo.galyleo_exceptions; Exceptions thrown by the package

Test 2

Installation
------------
Expand All @@ -35,32 +33,8 @@ Galyleo Table
JupyterLab Client
-----------------

*class* **GalyleoClient**

The Dashboard Client. This is the client which sends the tables to the dashboard and handles requests coming from the dashboard for tables.

method **GalyleoClient.__init__()**

Initialize the client. No parameters. This initializes communications with the JupyterLab Galyleo Communications Manager

**GalyleoClient.send_data_to_dashboard(galyleo_table, dashboard_name:str = None)**

The routine to send a GalyleoTable to the dashboard, optionally specifying a specific
dashboard to send the data to. If None is specified, sends to all the dashboards.
The table must not have more than galyleo_constants.MAX_NUMBER_ROWS, nor be (in JSON form) > galyleo_constants.MAX_DATA_SIZE.

If either of these conditions apply, a DataSizeExceeded exception is thrown.
NOTE: this sends data to one or more open dashboard editors in JupyterLab. If there are no dashboard editors open, it will have no effect.

*Args:*
- galyleo_table: the table to send to the dashboard
- dashboard_name: name of the dashboard editor to send it to (if None, sent to all)

*Returns:*
- None

*Raises:*
- galyleo_exceptions.DataSizeExceeded
.. automodule:: galyleo.galyleo_jupyterlab_client
:members:

Galyleo Exceptions
------------------
Expand Down
2 changes: 1 addition & 1 deletion source/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Galileo, of course, was the inventor of the telescope and the person who first s
Tutorials and Demos
-------------------

A number of tutorial and example projects can be found at `Galyleo Examples:<https://github.com/engageLively/galyleo-examples>`_.
A number of tutorial and example projects can be found at: `Galyleo Examples <https://github.com/engageLively/galyleo-examples>`_.


Reporting an issue
Expand Down

0 comments on commit 84ca1d6

Please sign in to comment.