|
| 1 | +.. _codebase: |
| 2 | + |
| 3 | +Codebase Orientation |
| 4 | +----------------- |
| 5 | +This codebase was adapted from JupyterLab's `csvviewer <https://github.com/jupyterlab/jupyterlab/tree/master/packages/csvviewer>`_ and `csvviewer-extension <https://github.com/jupyterlab/jupyterlab/tree/master/packages/csvviewer-extension>`_ packages. |
| 6 | + |
| 7 | +Directories |
| 8 | +~~~~~~~~~~~ |
| 9 | +The repository contains a number of top-level directories, the contents of which |
| 10 | +are described here. |
| 11 | + |
| 12 | +Source Code: ``src/`` |
| 13 | +^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 14 | +This contains the primary TypeScript files for this extension, which are compiled to JavaScript. |
| 15 | + |
| 16 | +Binder setup: ``binder/`` |
| 17 | +^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 18 | +This contains an environment specification for ``repo2docker`` which allows |
| 19 | +the repository to be tested on `mybinder.org <https://mybinder.org>`__. |
| 20 | + |
| 21 | +Demo: ``demo/`` |
| 22 | +^^^^^^^^^^^^^^^^^^^ |
| 23 | +The ``demo/`` directory contains sample csv files and Jupyter notebooks that highlight some features of this extension. |
| 24 | + |
| 25 | +Design: ``design/`` |
| 26 | +^^^^^^^^^^^^^^^^^^^ |
| 27 | +A directory containing a series of design documents and prototypes motivating various |
| 28 | +choices made in the course of building the Tabular Data Editor. |
| 29 | + |
| 30 | +Documentation: ``docs/`` |
| 31 | +^^^^^^^^^^^^^^^^^^^^^^^^ |
| 32 | +This directory contains the Sphinx project for this documentation. |
| 33 | +You can create an environment to build the documentation using ``conda create -f environment.yml``, |
| 34 | +and you can build the documentation by running ``make html``. |
| 35 | +The entry point to the built docs will then be in ``docs/build/index.html``. |
| 36 | + |
| 37 | +Styling: ``style/`` |
| 38 | +^^^^^^^^^^^^^^^^^^^ |
| 39 | +This directory contains the icon assets and css styles for this extension. |
| 40 | + |
| 41 | +Testing: ``test/`` |
| 42 | +^^^^^^^^^^^^^^^^^^^ |
| 43 | +Tests for the TypeScript files in the ``src/`` directory. |
| 44 | +These test files pull in the TypeScript sources and exercise their APIs. |
| 45 | + |
| 46 | +Run ``jlpm test`` from the root directory to run all tests for this extension |
| 47 | + |
| 48 | +Test Utilities: ``testutils/`` |
| 49 | +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 50 | +A small ``npm`` package which is aids in running the tests in ``tests/``. |
0 commit comments