Skip to content

Commit a1fe17e

Browse files
Readthedocs Documentation (#303) (#304)
* Update PROGRESS.md * documentation * Update index.rst * Update installation.rst * Update features.rst * smaller headers * Update overview.rst * Update codebase.rst * Update contribute.rst * Added docs badge to readme * Update ux.rst * Add files via upload * Changed img and gif for ux doc * updated keyboard shortcut headers * Update README.md * Update changelog.rst Co-authored-by: Logan McNichols <loganamcnichols@gmail.com> Co-authored-by: Kalen Goo <ktwmgoo@gmail.com>
1 parent 638e0ca commit a1fe17e

File tree

11 files changed

+1146
-2
lines changed

11 files changed

+1146
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1+
**[Documentation](https://jupyterlab-tabular-data-editor.readthedocs.io/)** | **[Contributing](#contributing)**
12
# jupyterlab-tabular-data-editor
23

34
### Manipulate your tabular data responsively and effectively within JupyterLab.
45

5-
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/jupytercalpoly/jupyterlab-tabular-data-editor/master?urlpath=lab) ![Github Actions Status](https://github.com/jupytercalpoly/jupyterlab-tabular-data-editor/workflows/Build/badge.svg) ![npm](https://img.shields.io/npm/v/jupyterlab-tabular-data-editor) ![npm](https://img.shields.io/npm/dt/jupyterlab-tabular-data-editor?color=orange)
6+
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/jupytercalpoly/jupyterlab-tabular-data-editor/master?urlpath=lab) ![Github Actions Status](https://github.com/jupytercalpoly/jupyterlab-tabular-data-editor/workflows/Build/badge.svg) [![Documentation Status](https://readthedocs.org/projects/jupyterlab-tabular-data-editor/badge/?version=latest)](https://jupyterlab-tabular-data-editor.readthedocs.io/en/latest/?badge=latest)
7+
![npm](https://img.shields.io/npm/v/jupyterlab-tabular-data-editor) ![npm](https://img.shields.io/npm/dt/jupyterlab-tabular-data-editor?color=orange)
68

79
### EXPERIMENTAL: This extension is still in alpha. The API is subject to frequent changes.
810

@@ -16,7 +18,7 @@ Read more about the Jupyter Tabular Data Editor Extension in our [press release]
1618

1719
Check out our [current progress and future plans](https://github.com/jupytercalpoly/jupyterlab-tabular-data-editor/blob/master/PROGRESS.md)!
1820

19-
See our progress as of 08/07/2020 from these [slides](https://docs.google.com/presentation/d/1ZGjFb3RkoR5Cc39DDdtU-AYAoYMNVMyUM9g80qgNzos/edit?usp=sharing)!
21+
See our progress as of 08/27/2020 from these [slides](https://docs.google.com/presentation/d/12M3riXxlj1GouMA5mIt6B1QbdA7MSt_KNf8h545I2oI/edit?usp=sharing)!
2022

2123
## Feature Showcase
2224
<details>

design/gifs/Toolbar.png

4.42 KB
Loading

design/gifs/context-menus.gif

4.64 MB
Loading

docs/contributor/codebase.rst

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
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

Comments
 (0)