fix documentation

Author: rmorshea

docs/main.py

@@ -2,7 +2,7 @@
 import sys
 from pathlib import Path
 
-from sanic import Sanic, response
+from sanic import Sanic
 
 import idom
 from idom.server.sanic import PerClientStateServer
@@ -12,12 +12,7 @@
 here = Path(__file__).parent
 
 app = Sanic(__name__)
-app.static("/docs", str(here / "build"))
-
-
-@app.route("/")
-async def forward_to_index(request):
-    return response.redirect("/docs/index.html")
+app.static("/", str(here / "build"))
 
 
 mount, component = multiview()
@@ -51,7 +46,9 @@ async def forward_to_index(request):
     idom.run = original_run
 
 
-PerClientStateServer(component, {"redirect_root_to_index": False}).register(app)
+PerClientStateServer(
+    component, {"redirect_root_to_index": False, "url_prefix": "/_idom"}
+).register(app)
 
 
 if __name__ == "__main__":

docs/source/_exts/interactive_widget.py

@@ -5,7 +5,7 @@
 from sphinx.application import Sphinx
 
 
-_IDOM_SERVER_LOC = os.environ.get("IDOM_DOC_EXAMPLE_SERVER_HOST", "")
+_IDOM_SERVER_LOC = os.environ.get("IDOM_DOC_EXAMPLE_SERVER_HOST", "") + "/_idom"
 
 
 class IteractiveWidget(Directive):
@@ -25,44 +25,8 @@ def run(self):
                 <div>
                     <div id="{container_id}" class="interactive widget-container center-content" style="" />
                     <script async type="module">
-                        const loc = window.location;
-                        const idom_url = "//" + ("{_IDOM_SERVER_LOC}" || loc.host);
-                        const http_proto = loc.protocol;
-                        const ws_proto = http_proto === "https:" ? "wss:" : "ws:";
-
-                        const mount = document.getElementById("{container_id}");
-                        const enableWidgetButton = document.createElement("button");
-                        enableWidgetButton.innerHTML = "Enable Widget";
-                        enableWidgetButton.setAttribute("class", "enable-widget-button")
-
-                        enableWidgetButton.addEventListener("click", () => {{
-                            import(http_proto + idom_url + "/client/index.js").then((module) => {{
-                                fadeOutAndThen(enableWidgetButton, () => {{
-                                    mount.removeChild(enableWidgetButton);
-                                    mount.setAttribute("class", "interactive widget-container");
-                                    module.mountLayoutWithWebSocket(
-                                      mount,
-                                      ws_proto + idom_url + "/stream?view_id={view_id}",
-                                    );
-                                }});
-                            }});
-                        }});
-
-                        function fadeOutAndThen(element, callback) {{
-                            var op = 1;  // initial opacity
-                            var timer = setInterval(function () {{
-                                if ( op < 0.001 ) {{
-                                    clearInterval(timer);
-                                    element.style.display = "none";
-                                    callback();
-                                }}
-                                element.style.opacity = op;
-                                element.style.filter = 'alpha(opacity=' + op * 100 + ")";
-                                op -= op * 0.5;
-                            }}, 50);
-                        }}
-
-                        mount.appendChild(enableWidgetButton);
+                        import loadWidgetExample from "/_static/js/load-widget-example.js";
+                        loadWidgetExample("{_IDOM_SERVER_LOC}", "{container_id}", "{view_id}");
                     </script>
                 </div>
                 """,

docs/source/_static/js/load-widget-example.js

@@ -0,0 +1,52 @@
+export default function loadWidgetExample(idomServerLocation, mountID, viewID) {
+  const loc = window.location;
+  const idom_url = "//" + (idomServerLocation || loc.host);
+  const http_proto = loc.protocol;
+  const ws_proto = http_proto === "https:" ? "wss:" : "ws:";
+
+  const mount = document.getElementById(mountID);
+  const enableWidgetButton = document.createElement("button");
+  enableWidgetButton.innerHTML = "Enable Widget";
+  enableWidgetButton.setAttribute("class", "enable-widget-button");
+
+  enableWidgetButton.addEventListener("click", () => {
+    {
+      import(http_proto + idom_url + "/client/src/index.js").then((module) => {
+        {
+          fadeOutAndThen(enableWidgetButton, () => {
+            {
+              mount.removeChild(enableWidgetButton);
+              mount.setAttribute("class", "interactive widget-container");
+              module.mountLayoutWithWebSocket(
+                mount,
+                ws_proto + idom_url + `/stream?view_id=${viewID}`
+              );
+            }
+          });
+        }
+      });
+    }
+  });
+
+  function fadeOutAndThen(element, callback) {
+    {
+      var op = 1; // initial opacity
+      var timer = setInterval(function () {
+        {
+          if (op < 0.001) {
+            {
+              clearInterval(timer);
+              element.style.display = "none";
+              callback();
+            }
+          }
+          element.style.opacity = op;
+          element.style.filter = "alpha(opacity=" + op * 100 + ")";
+          op -= op * 0.5;
+        }
+      }, 50);
+    }
+  }
+
+  mount.appendChild(enableWidgetButton);
+}

docs/source/installation.rst

@@ -17,7 +17,7 @@ For more installation options see the :ref:`Extra Features` section.
 
 .. note::
 
-    To contribute to IDOM, refer to the :ref:`Developer Workflow` instructions.
+    To contribute to IDOM, refer to the :ref:`Developer Guide` instructions.
 
 
 Extra Features

docs/source/package-api.rst

@@ -91,9 +91,6 @@ Client
 .. automodule:: idom.client.manage
     :members:
 
-.. automodule:: idom.client.utils
-    :members:
-
 
 Useful Tools
 ------------

noxfile.py

@@ -1,3 +1,4 @@
+import os
 import re
 from pathlib import Path
 from typing import List
@@ -56,10 +57,14 @@ def docs(session: Session) -> None:
         "python",
         "scripts/live_docs.py",
         "--open-browser",
+        "--ignore=build/**/*",
+        "-a",
+        "-E",
         "-b",
         "html",
         "docs/source",
         "docs/build",
+        env={"PYTHONPATH": os.getcwd()},
     )
 
 
@@ -142,4 +147,5 @@ def test_docs(session: Session) -> None:
 
 def install_idom_dev(session: Session, extras: str = "stable") -> None:
     session.install("-e", f".[{extras}]")
-    session.run("idom", "client", "restore")
+    if "--no-restore" not in session.posargs:
+        session.run("idom", "client", "restore")

scripts/live_docs.py

@@ -26,7 +26,9 @@ def new_builder():
 
         importlib.reload(main)
 
-        server = PerClientStateServer(main.component, {"cors": True})
+        server = PerClientStateServer(
+            main.component, {"cors": True, "url_prefix": "_idom"}
+        )
         _running_idom_servers.append(server)
         server.daemon("127.0.0.1", 5555, debug=True)
         old_builder()

src/idom/client/manage.py

@@ -89,7 +89,7 @@ def build(packages_to_install: Sequence[str], clean_build: bool = True) -> None:
         }
 
         # make sure we don't delete anything we've already installed
-        built_package_json_path = temp_build_dir / "package.json"
+        built_package_json_path = _private.build_dir() / "package.json"
         if not clean_build and built_package_json_path.exists():
             built_package_json = json.loads(built_package_json_path.read_text())
             for dep_name, dep_ver in built_package_json.get("dependencies", {}).items():