Add pdoc

Signed-off-by: Andrew Stein <steinlink@gmail.com>

Author: texodus

.gitignore

@@ -60,3 +60,5 @@ vcpkg
 venv/
 rust/perspective-python/perspective_python-*.data
 .pytest-cache/
+docs/static/python
+

docs/docusaurus.config.js

@@ -39,6 +39,10 @@ const examples = fs.readdirSync("static/blocks").map((ex) => {
     };
 });
 
+function link(title, path) {
+    return `<a class="dropdown__link" href="${path}">    ${title}</a>`;
+}
+
 /** @type {import('@docusaurus/types').Config} */
 const config = {
     title: "Perspective",
@@ -119,20 +123,73 @@ const config = {
                         label: "Docs",
                         items: [
                             {
-                                href: "/guide/",
-                                label: "User Guide",
+                                type: "html",
+                                value: `<a class="dropdown__link" style="font-size:16px;padding:0.25rem 0rem" href="/guide/">User Guide</a>`,
+                            },
+                            {
+                                type: "html",
+                                value: '<span style="user-select:none">Python API</span>',
+                            },
+                            {
+                                type: "html",
+                                value: `<a class="dropdown__link" href="/python/"><code>perspective</code></a>`,
+                            },
+                            {
+                                type: "html",
+                                value: `<a class="dropdown__link" href="/python/perspective/widget.html"><code>perspective.widget</code></a>`,
+                            },
+                            {
+                                type: "html",
+                                value: `<a class="dropdown__link" href="/python/perspective/handlers/aiohttp.html"><code>perspective.handlers.aiohttp</code></a>`,
+                            },
+                            {
+                                type: "html",
+                                value: `<a class="dropdown__link" href="/python/perspective/handlers/starlette.html"><code>perspective.handlers.starlette</code></a>`,
+                            },
+                            {
+                                type: "html",
+                                value: `<a class="dropdown__link" href="/python/perspective/handlers/tornado.html"><code>perspective.handlers.tornado</code></a>`,
+                            },
+                            {
+                                type: "html",
+                                value: '<span style="user-select:none">JavaScript API</span>',
+                            },
+                            {
+                                type: "html",
+                                value: link(
+                                    "<code>@finos/perspective-viewer</code>",
+                                    "/viewer/modules/perspective-viewer.html"
+                                ),
+                            },
+                            {
+                                type: "html",
+                                value: link(
+                                    "<code>@finos/perspective</code> Browser",
+                                    "/browser/modules/src_ts_perspective.browser.ts.html"
+                                ),
+                            },
+                            {
+                                type: "html",
+                                value: link(
+                                    "<code>@finos/perspective</code> Node.js",
+                                    "/node/modules/src_ts_perspective.node.ts.html"
+                                ),
+                            },
+                            {
+                                type: "html",
+                                value: '<span style="user-select:none">Rust API</span>',
                             },
                             {
                                 type: "html",
-                                value: `<a class="dropdown__link" href="https://docs.rs/perspective-js/latest/perspective_js/"><code>@finos/perspective</code> JavaScript API</a>`,
+                                value: `<a class="dropdown__link" href="https://docs.rs/perspective-js/latest/perspective_js/"><code>perspective-js</code></a>`,
                             },
                             {
                                 type: "html",
-                                value: `<a class="dropdown__link" href="https://docs.rs/perspective-python/latest/perspective_python/"><code>perspective-python</code> Python API</a>`,
+                                value: `<a class="dropdown__link" href="https://docs.rs/perspective-python/latest/perspective_python/"><code>perspective-python</code></a>`,
                             },
                             {
                                 type: "html",
-                                value: `<a class="dropdown__link" href="https://docs.rs/perspective/latest/perspective/"><code>perspective</code> Rust API</a>`,
+                                value: `<a class="dropdown__link" href="https://docs.rs/perspective/latest/perspective/"><code>perspective</code></a>`,
                             },
                         ],
                     },

examples/webpack-example/webpack.config.js

@@ -32,7 +32,7 @@ module.exports = {
             },
             {
                 test: /(perspective\-server\.wasm|perspective\-viewer\.wasm)$/,
-                type: "asset/resource"
+                type: "asset/resource",
             },
             {
                 test: /\.arrow$/,

rust/perspective-client/src/rust/client.rs

@@ -120,7 +120,7 @@ mod name_registry {
 pub type ReconnectCallback =
     Arc<dyn Fn() -> LocalBoxFuture<'static, Result<(), Box<dyn Error>>> + Send + Sync>;
 
-/// An instance of a [`Client`] is a unique connection to a single
+/// An instance of a [`Client`] is a connection to a single
 /// `perspective_server::Server`, whether locally in-memory or remote over some
 /// transport like a WebSocket.
 ///
@@ -411,6 +411,7 @@ impl Client {
     /// - CSV
     /// - JSON row-oriented
     /// - JSON column-oriented
+    /// - NDJSON
     ///
     /// When instantiated with _data_, the schema is inferred from this data.
     /// While this is convenient, inferrence is sometimes imperfect e.g.

rust/perspective-client/src/rust/session.rs

@@ -54,6 +54,7 @@ type ProxyCallbackError = Box<dyn StdError + Send + Sync>;
 type ProxyCallback = Arc<dyn Fn(&[u8]) -> Result<(), ProxyCallbackError> + Send + Sync>;
 
 /// A [`Session`] implementation which tunnels through another [`Client`].
+/// @private
 #[derive(Clone)]
 pub struct ProxySession {
     parent: Client,

rust/perspective-client/src/rust/table.rs

@@ -211,7 +211,7 @@ impl Table {
     ///     ..default()
     /// };
     /// let table = client.table("x,y\n1,2\n3,4", options).await;
-    /// let tables = client.open_table("table_one").await;
+    /// let index = table.get_index()
     /// ```
     pub fn get_index(&self) -> Option<String> {
         self.options.index.as_ref().map(|index| index.to_owned())

rust/perspective-client/src/rust/view.rs

@@ -262,8 +262,8 @@ impl View {
         }
     }
 
-    /// A copy of the config object passed to the [`Table::view`] method which
-    /// created this [`View`].
+    /// A copy of the [`ViewConfig`] object passed to the [`Table::view`] method
+    /// which created this [`View`].
     pub async fn get_config(&self) -> ClientResult<crate::config::ViewConfig> {
         let msg = self.client_message(ClientReq::ViewGetConfigReq(ViewGetConfigReq {}));
         match self.client.oneshot(&msg).await? {

rust/perspective-js/src/rust/client.rs

@@ -77,7 +77,7 @@ impl ProxySession {
     }
 }
 
-/// An instance of a [`Client`] is a unique connection to a single
+/// An instance of a [`Client`] is a connection to a single
 /// `perspective_server::Server`, whether locally in-memory or remote over some
 /// transport like a WebSocket.
 ///
@@ -299,6 +299,7 @@ impl Client {
     /// - CSV
     /// - JSON row-oriented
     /// - JSON column-oriented
+    /// - NDJSON
     ///
     /// When instantiated with _data_, the schema is inferred from this data.
     /// While this is convenient, inferrence is sometimes imperfect e.g.

rust/perspective-js/src/rust/lib.rs

@@ -18,6 +18,7 @@
     clippy::all,
     clippy::panic_in_result_fn,
     clippy::await_holding_refcell_ref,
+    rustdoc::broken_intra_doc_links,
     unstable_features
 )]
 #![allow(non_snake_case)]

rust/perspective-js/src/rust/table.rs

@@ -245,8 +245,8 @@ impl Table {
     }
 
     /// Replace all rows in this [`Table`] with the input data, coerced to this
-    /// [`Table`]'s existing [`Schema`], notifying any derived [`View`] and
-    /// [`View::on_update`] callbacks.
+    /// [`Table`]'s existing [`perspective_client::Schema`], notifying any
+    /// derived [`View`] and [`View::on_update`] callbacks.
     ///
     /// Calling [`Table::replace`] is an easy way to replace _all_ the data in a
     /// [`Table`] without losing any derived [`View`] instances or