fix documentation

also includes:
- fix issue where client did not remove fallback from DOM
- add option to symlink module_from_file into web modules dir

Author: rmorshea

.github/workflows/test.yml

@@ -30,7 +30,7 @@ jobs:
       - name: Install Python Dependencies
         run: pip install -r requirements/test-run.txt
       - name: Run Tests
-        run: nox -s test -- --headless
+        run: nox -s test --verbose -- --headless
   test-python-versions:
     runs-on: ${{ matrix.os }}
     strategy:
@@ -54,7 +54,7 @@ jobs:
       - name: Install Python Dependencies
         run: pip install -r requirements/test-run.txt
       - name: Run Tests
-        run: nox -s test -- --headless --no-cov
+        run: nox -s test --verbose -- --headless --no-cov
   test-javascript:
     runs-on: ubuntu-latest
     steps:

.gitignore

@@ -35,3 +35,7 @@ pip-wheel-metadata
 # --- IDE ---
 .idea
 .vscode
+
+# --- JS ---
+
+node_modules

docs/source/_exts/build_custom_js.py

@@ -0,0 +1,12 @@
+import subprocess
+from pathlib import Path
+
+from sphinx.application import Sphinx
+
+
+SOURCE_DIR = Path(__file__).parent.parent
+CUSTOM_JS_DIR = SOURCE_DIR / "custom_js"
+
+
+def setup(app: Sphinx) -> None:
+    subprocess.run(["npm", "run", "build"], cwd=CUSTOM_JS_DIR, shell=True)

docs/source/_exts/interactive_widget.py

@@ -26,8 +26,8 @@ def run(self):
                 <div>
                     <div id="{container_id}" class="interactive widget-container center-content" style="" />
                     <script async type="module">
-                        import loadWidgetExample from "{_IDOM_STATIC_HOST}/_static/js/load-widget-example.js";
-                        loadWidgetExample("{_IDOM_EXAMPLE_HOST}", "{container_id}", "{view_id}");
+                        import {{ mountWidgetExample }} from "{_IDOM_STATIC_HOST}/_static/custom.js";
+                        mountWidgetExample("{container_id}", "{view_id}", "{_IDOM_EXAMPLE_HOST}");
                     </script>
                 </div>
                 """,

docs/source/_static/custom.js

@@ -1,12 +1,6 @@
 API Reference
 =============
 
-.. automodule:: idom.client.manage
-    :members:
-
-.. automodule:: idom.client.module
-    :members:
-
 .. automodule:: idom.config
     :members:
 
@@ -28,7 +22,7 @@ API Reference
 .. automodule:: idom.core.vdom
     :members:
 
-.. automodule:: idom.dialect
+.. automodule:: idom.html
     :members:
 
 .. automodule:: idom.log
@@ -55,7 +49,7 @@ API Reference
 .. automodule:: idom.utils
     :members:
 
-.. automodule:: idom.html
+.. automodule:: idom.web.module
     :members:
 
 .. automodule:: idom.widgets
@@ -64,9 +58,6 @@ API Reference
 Misc Modules
 ------------
 
-.. automodule:: idom.cli
-    :members:
-
 .. automodule:: idom.core.utils
     :members:
 
@@ -75,3 +66,6 @@ Misc Modules
 
 .. automodule:: idom.server.utils
     :members:
+
+.. automodule:: idom.web.utils
+    :members:

docs/source/auto/api-reference.rst

@@ -3,9 +3,3 @@ Developer APIs
 
 .. automodule:: idom._option
     :members:
-
-Misc Dev Modules
-----------------
-
-.. automodule:: idom.client._private
-    :members:

docs/source/auto/developer-apis.rst

@@ -64,6 +64,7 @@
     "interactive_widget",
     "patched_html_translator",
     "widget_example",
+    "build_custom_js",
 ]
 
 # Add any paths that contain templates here, relative to this directory.

docs/source/conf.py

@@ -0,0 +1,9 @@
+# Custom Javascript for IDOM's Docs
+
+Build the javascript with
+
+```
+npm run build
+```
+
+This will drop a javascript bundle into `../_static/custom.js`