more docs

Author: rmorshea

README.md

@@ -20,7 +20,7 @@ or create a
 [pull request](https://github.com/rmorshea/idom/pulls). Thanks in advance!
 
 <h3>
-  <a href="https://mybinder.org/v2/gh/rmorshea/idom/master?filepath=examples%2Fintroduction.ipynb">
+  <a href="https://mybinder.org/v2/gh/rmorshea/idom/master?filepath=notebooks%2Fintroduction.ipynb">
     Try it Now
     <img alt="Binder" valign="bottom" height="25px"
     src="https://mybinder.org/badge_logo.svg"

docs/source/api.rst

@@ -53,38 +53,31 @@ Sanic Servers
 Useful Tools
 ------------
 
-.. automodule:: idom.tools
+.. automodule:: idom.utils
     :members:
 
 
-Common Widgets
+Jupyter Widget
 --------------
 
-.. automodule:: idom.widgets.common
+.. automodule:: idom.widgets.jupyter
     :members:
 
 
-Display Utilities
------------------
+HTML Widgets
+------------
 
-.. automodule:: idom.widgets.display
+.. automodule:: idom.widgets.html
     :members:
+    :undoc-members:
 
-
-Input Helper
+Widget Tools
 ------------
 
-.. automodule:: idom.widgets.inputs
+.. automodule:: idom.widgets.utils
     :members:
 
 
-HTML Nodes
-----------
-
-.. automodule:: idom.widgets.html
-    :members:
-    :undoc-members:
-
 Dialect
 -------
 

docs/source/examples.rst

@@ -135,7 +135,7 @@ Simply install your javascript library of choice using the ``idom`` CLI:
 
     idom install victory
 
-Then import the module with :class:`idom.widgets.utils.Module`:
+Then import the module with :class:`~idom.widgets.utils.Module`:
 
 .. literalinclude:: examples/victory_chart.py
 
@@ -167,7 +167,7 @@ Source of ``chart.js``:
 Shared Client Views
 -------------------
 
-This example requires the :ref:`idom.server.sanic.SharedClientState` server. Be sure to
+This example requires the :ref:`~idom.server.sanic.SharedClientStateServer`. Be sure to
 replace it in your boilerplate code before going further! Once you've done this we can
 just re-display our :ref:`Slideshow` example using the new server. Now all we need to do
 is connect to the server with a couple clients to see that their views are synced. This

docs/source/getting-started.rst

@@ -38,7 +38,7 @@ Since it's likely a lot to take in at once, we'll break it down piece by piece:
 
 The ``idom.element`` decorator creates an :ref:`Element <Stateful Element>` constructor
 whose render function is defined by the `asynchronous function`_ below it. To create
-an :class:`idom.core.element.Element` instance we call ``Slideshow()`` with the same
+an :class:`~idom.core.element.Element` instance we call ``Slideshow()`` with the same
 arguments as its render function. The render function of an Element returns a data
 structure that depicts a user interface, or in more technical terms a Document Object
 Model (DOM). We call this structural representation of the DOM a `Virtual DOM`__ (VDOM)

docs/source/index.rst

@@ -92,4 +92,4 @@ cause the widget to change 🖱️
 .. _pull request: https://github.com/rmorshea/idom/pulls
 .. _IDOM Sandbox: https://idom-sandbox.herokuapp.com
 .. |launch-binder| image:: https://mybinder.org/badge_logo.svg
-   :target: https://mybinder.org/v2/gh/rmorshea/idom/master?filepath=examples%2Fintroduction.ipynb
+   :target: https://mybinder.org/v2/gh/rmorshea/idom/master?filepath=notebooks%2Fintroduction.ipynb

idom/widgets/html.py

@@ -15,6 +15,10 @@ def image(
     value: Union[str, bytes] = "",
     attributes: Optional[Dict[str, Any]] = None,
 ) -> VdomDict:
+    """Utility for constructing an image from a string or bytes
+
+    The source value will automatically be encoded to base64
+    """
     if format == "svg":
         format = "svg+xml"
 
@@ -38,6 +42,7 @@ async def Input(
     cast: Optional[Callable[[str], Any]] = None,
     ignore_empty: bool = True,
 ) -> VdomDict:
+    """Utility for making an ``<input/>`` with a callback"""
     attrs = attributes or {}
     value, set_value = idom.hooks.use_state(value)
 
@@ -55,6 +60,14 @@ async def on_change(event: Dict[str, Any]) -> None:
 
 
 class Html:
+    """Utility for making basic HTML elements
+
+    Many basic elements already have constructors, however accessing an attribute
+    of any name on this object will return a constructor for an element with the
+    same ``tagName``.
+
+    All constructors return :class:`~idom.core.vdom.VdomDict`.
+    """
 
     __call__ = staticmethod(component)
 
@@ -158,3 +171,7 @@ def __getattr__(self, tag: str) -> VdomDictConstructor:
 
 
 html = Html()
+"""Holds pre-made constructors for basic HTML elements
+
+See :class:`Html` for more info.
+"""