Skip to content

Commit 797ad14

Browse files
texodustexodus
committed
Update docs
Signed-off-by: Andrew Stein <steinlink@gmail.com>
1 parent 7c134b3 commit 797ad14

File tree

144 files changed

+7603
-3288
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

144 files changed

+7603
-3288
lines changed

‎.github/workflows/build.yaml‎

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -168,8 +168,6 @@ jobs:
168168
packages/perspective-viewer-d3fc/dist
169169
packages/perspective-viewer-datagrid/dist
170170
packages/perspective-viewer-openlayers/dist
171-
packages/perspective-esbuild-plugin/dist
172-
packages/perspective-webpack-plugin/dist
173171
packages/perspective-cli/dist
174172
packages/perspective-workspace/dist
175173
@@ -947,12 +945,6 @@ jobs:
947945
- run: pnpm pack --pack-destination=../..
948946
working-directory: ./packages/perspective-cli
949947

950-
- run: pnpm pack --pack-destination=../..
951-
working-directory: ./packages/perspective-webpack-plugin
952-
953-
- run: pnpm pack --pack-destination=../..
954-
working-directory: ./packages/perspective-esbuild-plugin
955-
956948
- run: pnpm pack --pack-destination=../..
957949
working-directory: ./packages/perspective-jupyterlab
958950

‎README.md‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
<br />
2-
<a href="https://github.com/finos/perspective/blob/master/docs/static/svg/perspective-logo-light.svg?raw=true#gh-light-mode-only"><img src="https://github.com/finos/perspective/raw/master/docs/static/svg/perspective-logo-light.svg?raw=true#gh-light-mode-only" alt="Perspective" width="260"></a>
3-
<a href="https://github.com/finos/perspective/blob/master/docs/static/svg/perspective-logo-dark.svg?raw=true#gh-dark-mode-only"><img src="https://github.com/finos/perspective/raw/master/docs/static/svg/perspective-logo-dark.svg?raw=true#gh-dark-mode-only" alt="Perspective" width="260"></a>
2+
<a href="https://perspective.finos.org">
3+
<picture>
4+
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/finos/perspective/raw/master/docs/static/svg/perspective-logo-dark.svg?raw=true">
5+
<img width="260" src="https://github.com/finos/perspective/raw/master/docs/static/svg/perspective-logo-light.svg?raw=true">
6+
</picture>
7+
</a>
48
<br/><br/>
59

610
[![Build Status](https://img.shields.io/github/actions/workflow/status/finos/perspective/build.yaml?event=push&style=for-the-badge)](https://github.com/finos/perspective/actions/workflows/build.yaml)

‎docs/book.toml‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
2+
# ┃ ██████ ██████ ██████ █ █ █ █ █ █▄ ▀███ █ ┃
3+
# ┃ ▄▄▄▄▄█ █▄▄▄▄▄ ▄▄▄▄▄█ ▀▀▀▀▀█▀▀▀▀▀ █ ▀▀▀▀▀█ ████████▌▐███ ███▄ ▀█ █ ▀▀▀▀▀ ┃
4+
# ┃ █▀▀▀▀▀ █▀▀▀▀▀ █▀██▀▀ ▄▄▄▄▄ █ ▄▄▄▄▄█ ▄▄▄▄▄█ ████████▌▐███ █████▄ █ ▄▄▄▄▄ ┃
5+
# ┃ █ ██████ █ ▀█▄ █ ██████ █ ███▌▐███ ███████▄ █ ┃
6+
# ┣━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┫
7+
# ┃ Copyright (c) 2017, the Perspective Authors. ┃
8+
# ┃ ╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌ ┃
9+
# ┃ This file is part of the Perspective library, distributed under the terms ┃
10+
# ┃ of the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0). ┃
11+
# ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
12+
13+
[book]
14+
authors = ["Andrew Stein"]
15+
language = "en"
16+
multilingual = false
17+
src = "md"
18+
title = "Perspective"
19+
20+
[build]
21+
build-dir = "static/guide"
22+
23+
[output.html]
24+
# theme = "my-theme"
25+
# default-theme = "light"
26+
# preferred-dark-theme = "navy"
27+
# smart-punctuation = true
28+
# mathjax-support = false
29+
copy-fonts = true
30+
git-repository-url = "https://github.com/finos/perspective"
31+
git-repository-icon = "fa-github"
32+
site-url = "https://perspective.finos.org/guide/"
33+
additional-css = [
34+
"md/perspective.css",
35+
"node_modules/@finos/perspective-viewer/dist/css/themes.css",
36+
]
37+
# additional-js = []
38+
# no-section-label = false
39+
# edit-url-template = "https://github.com/rust-lang/mdBook/edit/master/guide/{path}"
40+
# site-url = "/guide/"
41+
# cname = "myproject.rs"
42+
# input-404 = "not-found.md"

‎docs/md/SUMMARY.md‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Summary
2+
3+
[What is Perspective](./perspective.md)
4+
5+
# Overview
6+
7+
- [Data Architecture](./explanation/architecture.md)
8+
- [Client-only](./explanation/architecture/client_only.md)
9+
- [Client/Server replicated](./explanation/architecture/client_server.md)
10+
- [Server only](./explanation/architecture/server_only.md)
11+
- [`Table`](./explanation/table.md)
12+
- [Construct an empty `Table` from a schema](./explanation/table/constructing_schema.md)
13+
- [Schema and column types](./explanation/table/schema.md)
14+
- [Loading data](./explanation/table/loading_data.md)
15+
- [`index` and `limit` options](./explanation/table/options.md)
16+
- [`update()` and `remove()` streaming methods](./explanation/table/update_and_remove.md)
17+
- [`clear()` and `replace()` start-over methods](./explanation/table/clear_and_replace.md)
18+
- [`View`](./explanation/view.md)
19+
- [Querying data](./explanation/view/querying.md)
20+
- [`group_by`](./explanation/view/config/group_by.md)
21+
- [`split_by`](./explanation/view/config/split_by.md)
22+
- [`aggregates`](./explanation/view/config/aggregates.md)
23+
- [`columns`](./explanation/view/config/columns.md)
24+
- [`sort`](./explanation/view/config/sort.md)
25+
- [`filter`](./explanation/view/config/filter.md)
26+
- [`expressions`](./explanation/view/config/expressions.md)
27+
- [Flattening a View into a Table](./explanation/view/config/flattening.md)
28+
- [JavaScript](./explanation/javascript.md)
29+
- [Module Structure](./explanation/javascript_module_structure.md)
30+
- [Build options](./explanation/javascript_builds.md)
31+
- [Python](./explanation/python.md)
32+
33+
# Getting Started
34+
35+
- [Rust](./how_to/rust.md)
36+
- [JavaScript](./how_to/javascript.md)
37+
- [Installation via NPM](./how_to/javascript/installation.md)
38+
- [Importing with or without a bundler](./how_to/javascript/importing.md)
39+
- [`perspective` data engine library](./how_to/javascript/worker.md)
40+
- [Serializing data](./how_to/javascript/serializing.md)
41+
- [Cleaning up resources](./how_to/javascript/deleting.md)
42+
- [Hosting a `WebSocketServer` in Node.js](./how_to/javascript/nodejs_server.md)
43+
- [`perspective-viewer` Custom Element library](./how_to/javascript/viewer.md)
44+
- [Theming](./how_to/javascript/theming.md)
45+
- [Loading data from a `Table`](./how_to/javascript/loading_data.md)
46+
- [Loading data from a virtual `Table`](./how_to/javascript/loading_virtual_data.md)
47+
- [Saving and restoring UI state](./how_to/javascript/save_restore.md)
48+
- [Listening for events](./how_to/javascript/events.md)
49+
- [Python](./how_to/python.md)
50+
- [Installation](./how_to/python/installation.md)
51+
- [Loading data into a `Table`](./how_to/python/table.md)
52+
- [Callbacks and events](./how_to/python/callbacks.md)
53+
- [Multithreading](./how_to/python/multithreading.md)
54+
- [Hosting a WebSocket server](./how_to/python/websocket.md)
55+
- [`PerspectiveWidget` for JupyterLab](./how_to/python/jupyterlab.md)
56+
- [Tutorial: A `tornado` server with virtual `perspective-viewer`](./tutorials/python/tornado.md)
57+
58+
# API
59+
60+
- [Crate documentation on `docs.rs` ](./api_reference.md)

‎docs/md/api_reference.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# API Reference
2+
3+
Perspective's complete API is hosted on `docs.rs`:
4+
5+
- [`perspective-client`](https://docs.rs/perspective-client/latest/perspective_client/index.html)
6+
covers `Table` and `View` data engine API methods common for Rust,
7+
JavaScript and Python.
8+
- [`perspective-rs`](https://docs.rs/perspective-client/latest/perspective_client/index.html)
9+
adds Rust-specific documentation for the Rust crate entrypoint.

‎docs/md/explanation.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Explanation

‎docs/md/explanation/architecture.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Data Architecture
2+
3+
Application developers can choose from
4+
[Client (WebAssembly)](./architecture/client_only.md),
5+
[Server (Python/Node)](./architecture/server_only.md) or
6+
[Client/Server Replicated](./architecture/client_server.md) designs to bind
7+
data, and a web application can use one or a mix of these designs as needed. By
8+
serializing to Apache Arrow, tables are duplicated and synchronized across
9+
runtimes efficiently.
10+
11+
Perspective is a multi-language platform. The examples in this section use
12+
Python and JavaScript as an example, but the same general principles apply to
13+
any `Client`/`Server` combination.
14+
15+
<img src="./architecture/architecture.svg" />

rust/perspective-server/docs/architecture.dot renamed to docs/md/explanation/architecture/architecture.dot

File renamed without changes.

rust/perspective-server/docs/architecture.sub1.dot renamed to docs/md/explanation/architecture/architecture.sub1.dot

File renamed without changes.

rust/perspective-server/docs/architecture.sub1.svg renamed to docs/md/explanation/architecture/architecture.sub1.svg

File renamed without changes.

0 commit comments

Comments
 (0)