share LabIcon user guide betwen pkg and docs; add "reusing jlab ui" sec

.gitignore

@@ -11,6 +11,7 @@ dev_mode/stats.json
 docs/_build
 docs/api
 docs/source/_build
+docs/source/_markdown
 
 examples/app/build
 examples/app/themes

docs/source/conf.py

@@ -17,7 +17,8 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
-# import os
+import os
+import shutil
 # import sys
 # sys.path.insert(0, os.path.abspath('.'))
 
@@ -31,6 +32,16 @@ from recommonmark.transform import AutoStructify
 #
 # needs_sphinx = '1.0'
 
+# Path to a directory where markdown sources are kept
+md_dir = 'source/_markdown'
+
+# A list of paths to any markdown sources located above this docs dir.
+# Used to work around the fact that you generally can't link to files
+# outside of the docs build
+md_sources = [
+    '../packages/ui-components/markdown/labicon.md'
+]
+
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
@@ -236,7 +247,17 @@ github_doc_root = 'https://github.com/jupyterlab/jupyterlab/tree/master/docs/'
 # markdown documents.
 linkcheck_anchors = False
 
+def copyMarkdown():
+    shutil.rmtree(md_dir, ignore_errors=True)
+    os.makedirs(md_dir)
+
+    for pth in md_sources:
+        shutil.copy(pth, md_dir)
+
 def setup(app):
+    # set up the markdown sources
+    copyMarkdown()
+
     app.add_config_value('recommonmark_config', {
         'url_resolver': lambda url: github_doc_root + url,
         'auto_toc_tree_section': 'Contents',

docs/source/developer/extension_points.rst

@@ -206,94 +206,7 @@ default plugin provided by the built-in file browser.
 Icons
 ~~~~~
 
-``LabIcon`` is the icon class used by JupyterLab, and is part of the new icon
-system introduced in JupyterLab v2.0.
-
-How JupyterLab handles icons
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-The ui-components package provides icons to the rest of JupyterLab, in the
-form of a set of ``LabIcon`` instances (currently about 80). All of the icons
-in the core JupyterLab packages are rendered using one of these ``LabIcon``
-instances.
-
-Using the icons in your own code
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-You can use any of JupyterLab icons in your own code via an ``import``
-statement. For example, to use ``jupyterIcon`` you would first do:
-
-.. code:: typescript
-
-  import { jupyterIcon } from "@jupyterlab/ui-components";
-
-How to render an icon into a DOM node
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Icons can be added as children to any ``div`` or ``span`` nodes using the
-`icon.element(...)` method (where ``icon`` is any instance of ``LabIcon``).
-For example, to render the Jupyter icon you could do:
-
-.. code:: typescript
-
-  jupyterIcon.element({
-    container: elem,
-    height: '16px',
-    width: '16px',
-    marginLeft: '2px'
-  });
-
-where ``elem`` is any ``HTMLElement`` with a ``div`` or ``span`` tag. As shown in
-the above example, the icon can be styled by passing CSS parameters into
-`.element(...)`. Any valid CSS parameter can be used, with one caveat:
-snake case params have to be converted to camel case. For example, instead
-of `foo-bar: '8px'`, you'd need to use `fooBar: '8px'`.
-
-How to render an icon as a React component
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Icons can also be rendered using React. The `icon.react` parameter holds a
-standard React component that will display the icon on render. Like any React
-component, `icon.react` can be used in various ways.
-
-For example, here is how you would add the Jupyter icon to the render tree of
-another React component:
-
-.. code:: jsx
-
-  public render() {
-    return (
-      <div className="outer">
-        <div className="inner">
-          <jupyterIcon.react
-            tag="span"
-            right="7px"
-            top="5px"
-          />
-          "and here's a text node"
-        </div>
-      </div>
-    );
-  }
-
-Alternatively, you can just render the icon directly into any existing DOM
-node ``elem`` by using the ``ReactDOM`` module:
-
-.. code:: typescript
-
-  ReactDOM.render(jupyterIcon.react, elem);
-
-If do you use ``ReactDOM`` to render, and if the ``elem`` node is ever removed
-from the DOM, you'll first need to clean it up:
-
-.. code:: typescript
-
-  ReactDOM.unmountComponentAtNode(elem);
-
-This cleanup step is not a special property of ``LabIcon``, but is instead
-needed for any React component that is rendered directly at the top level
-by ``ReactDOM``: failure to call `unmountComponentAtNode` can result in a
-`memory leak <https://stackoverflow.com/a/48198011/425458>`__.
+See :ref:`ui_components`
 
 
 Keyboard Shortcuts

docs/source/developer/ui_components.rst

@@ -0,0 +1,19 @@
+.. _ui_components:
+
+Reusing JupyterLab UI
+---------------------
+
+The `@jupyterlab/ui-components <http://jupyterlab.github.io/jupyterlab/ui-components/index.html>`__
+package provides UI elements that are widely used in JupyterLab
+core, and that can be reused in your own extensions.
+
+For example, all of the icons in JupyterLab core can be reused via
+``LabIcon``. You can also use ``LabIcon`` to create your own custom
+icons that will be able to automatically change color to match the
+current JupyterLab theme.
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Explainer docs
+
+   ../_markdown/labicon

docs/source/index.rst

@@ -53,6 +53,7 @@ JupyterLab is the next-generation web-based user interface for Project Jupyter.
    developer/extension_points
    developer/contributing
    developer/components
+   developer/ui_components
    developer/documents
    developer/notebook
    developer/patterns

packages/ui-components/README.md

@@ -1,162 +1,9 @@
 # @jupyterlab/ui-components
 
-A JupyterLab package that provides UI elements of various types (React components, DOM elements, etc) to core JupyterLab packages and third-party extensions.
+The @jupyterlab/ui-components package provides UI elements that are widely used in JupyterLab core, and that can be reused in your own extensions.
 
-# `LabIcon` user guide
+For example, all of the icons in JupyterLab core can be reused via `LabIcon`. You can also use `LabIcon` to create your own custom icons that will be able to automatically change color to match the current JupyterLab theme.
 
-`LabIcon` is the icon class used by JupyterLab, and is part of the new icon system introduced in JupyterLab v2.0.
+## User guides
 
-## Background
-
-### Icon handling in Jupyterlab
-
-Pre jlab-2.0, most icons were created using the icons-as-css-background pattern:
-
-- Set up the icon's svg as a `background-image` in CSS:
-
-  ```css
-  /* CSS */
-
-  :root {
-    --jp-icon-foo: url('path-to-your/foo.svg');
-  }
-
-  .jp-FooIcon {
-    background-image: var(--jp-icon-foo);
-  }
-  ```
-
-- Add the icon to the DOM by constructing an otherwise empty DOM node with the appropriate class:
-
-  ```typescript
-  // typescript
-
-  const e = document.createElement('div');
-  e.className = 'jp-FooIcon';
-  document.body.append(e);
-  ```
-
-What you end up with is a single DOM node that has the "foo" icon as a background image.
-
-Post jlab-2.0, nearly all icons in core are now created using [LabIcon](https://github.com/jupyterlab/jupyterlab/blob/f0153e0258b32674c9aec106383ddf7b618cebab/packages/ui-components/src/icon/labicon.tsx) and the icons-as-inline-svg pattern:
-
-- Construct a new instance of LabIcon from the icon's name and svg:
-
-  ```typescript
-  // typescript
-
-  // svgstr should be the raw contents of your icon's svg file
-  export const fooIcon = new LabIcon({
-    name: 'barpkg:foo',
-    svgstr: '<svg>...</svg>'
-  });
-  ```
-
-- Add the icon to the DOM using the appropriate property of your LabIcon instance (either LabIcon.element() to directly create a DOM node, or LabIcon.react to get the icon as a react component):
-
-  ```typescript
-  // typescript
-
-  const e = fooIcon.element();
-  document.body.append(e);
-  ```
-
-What you end up with is a DOM node (by default a 'div') that has an inline svg node as a child.
-
-### `background-image` vs inline svg
-
-The big limitation of the old icon-as-css-background pattern is that svg images rendered as `background-image` are invisible to CSS. On the other hand, an icon rendered as an inline svg node is fully exposed to the CSS. This allows us to dynamicly change icon styling as needed simply by modifying our CSS. Most importantly, this allows us to recolor icons according to Jupyterlab's current theme.
-
-## How JupyterLab handles icons
-
-The @jupyterlab/ui-components package provides icons to the rest of JupyterLab, in the form of a set of `LabIcon` instances (currently about 80). All of the icons in the core JupyterLab packages are rendered using one of these `LabIcon` instances.
-
-## Using the icons in your own code
-
-You can use any of JupyterLab icons in your own code via an `import` statement. For example, to use `jupyterIcon` you would first do:
-
-```typescript
-import { jupyterIcon } from '@jupyterlab/ui-components';
-```
-
-## How to render an icon into a DOM node
-
-Icons can be added as children to any `div` or `span` nodes using the `icon.element(...)` method (where `icon` is any instance of `LabIcon`). For example, to render the Jupyter icon you could do:
-
-```typescript
-jupyterIcon.element({
-  container: elem,
-  height: '16px',
-  width: '16px',
-  marginLeft: '2px'
-});
-```
-
-where `elem` is any `HTMLElement` with a `div` or `span` tag. As shown in the above example, the icon can be styled by passing CSS parameters into `.element(...)`. Any valid CSS parameter can be used (one catch: snake case params do have to be converted to camel case: instead of `foo-bar: '8px'`, you'd need to use `fooBar: '8px'`.
-
-## How to render an icon as a React component
-
-Icons can also be rendered using React. The `icon.react` parameter holds a standard React component that will display the icon on render. Like any React component, `icon.react` can be used in various ways.
-
-For example, here is how you would add the Jupyter icon to the render tree of another React component:
-
-```tsx
-  public render() {
-    return (
-      <div className="outer">
-        <div className="inner">
-          <jupyterIcon.react tag="span" right="7px" top="5px" />
-          "and here's a text node"
-        </div>
-      </div>
-    );
-  }
-```
-
-Alternatively, you can just render the icon directly into any existing DOM node `elem` by using the `ReactDOM` module:
-
-```typescript
-ReactDOM.render(jupyterIcon.react, elem);
-```
-
-If do you use `ReactDOM` to render, and if the `elem` node is ever removed from the DOM, you'll first need to clean it up:
-
-```typescript
-ReactDOM.unmountComponentAtNode(elem);
-```
-
-This cleanup step is not a special property of `LabIcon`, but is instead needed for any React component that is rendered directly at the top level by `ReactDOM`: failure to call `unmountComponentAtNode` can result in a [memory leak](https://stackoverflow.com/a/48198011/425458).
-
-## How to create your own custom `LabIcon`
-
-You can create your own custom icon by constructing a new instance of `LabIcon`:
-
-```typescript
-export const fooIcon = new LabIcon({
-  name: 'barpkg:foo',
-  svgstr: '<svg>...</svg>'
-});
-```
-
-where `name` should be of the form "your-pkg:icon-name", and `svgstr` is the raw contents of your icon's svg file.
-
-## How to create a new `LabIcon` from an external svg file
-
-Although you can copy-and-paste an svg directly into the `LabIcon` constructor, the best practice is to keep the svg for each of your icons in its own separate svg file. You will need to have an `svg.d.ts` file at the root of your project's `src` directory:
-
-```typescript
-// svg.d.ts
-
-declare module '*.svg' {
-  const value: string;
-  export default value;
-}
-```
-
-You can then `import` the contents of an svg file:
-
-```typescript
-import fooSvgstr from 'path-to-your/foo.svg';
-
-export const fooIcon = new LabIcon({ name: 'barpkg:foo', svgstr: fooSvgstr });
-```
+- [`LabIcon` - set up and render icons](markdown/labicon.md)

packages/ui-components/markdown/labicon.md

@@ -0,0 +1,154 @@
+# `LabIcon` - set up and render icons
+
+`LabIcon` is the icon class used by JupyterLab, and is part of the new icon system introduced in JupyterLab v2.0.
+
+## Background
+
+### Icon handling in Jupyterlab
+
+Pre jlab-2.0, most icons were created using the icons-as-css-background pattern:
+
+- Set up the icon's svg as a `background-image` in CSS:
+
+  ```css
+  /* CSS */
+
+  .jp-FooIcon {
+    background-image: url('path-to-your/foo.svg');
+  }
+  ```
+
+- Add the icon to the DOM by constructing an otherwise empty DOM node with the appropriate class:
+
+  ```typescript
+  // typescript
+
+  const e = document.createElement('div');
+  e.className = 'jp-FooIcon';
+  document.body.append(e);
+  ```
+
+What you end up with is a single DOM node that has the "foo" icon as a background image.
+
+Post jlab-2.0, nearly all icons in core are now created using [LabIcon](https://github.com/jupyterlab/jupyterlab/blob/f0153e0258b32674c9aec106383ddf7b618cebab/packages/ui-components/src/icon/labicon.tsx) and the icons-as-inline-svg pattern:
+
+- Construct a new instance of LabIcon from the icon's name and svg:
+
+  ```typescript
+  // typescript
+
+  // svgstr is the raw contents of an icon's svg file
+  export const fooIcon = new LabIcon({
+    name: 'barpkg:foo',
+    svgstr: '<svg>...</svg>'
+  });
+  ```
+
+- Add the icon to the DOM using the appropriate property of your LabIcon instance (either LabIcon.element() to directly create a DOM node, or LabIcon.react to get the icon as a react component):
+
+  ```typescript
+  // typescript
+
+  const e = fooIcon.element();
+  document.body.append(e);
+  ```
+
+What you end up with is a DOM node (by default a 'div') that has an inline svg node as a child.
+
+### `background-image` vs inline svg
+
+The big limitation of the old icon-as-css-background pattern is that svg images rendered as `background-image` are invisible to CSS. On the other hand, an icon rendered as an inline svg node is fully exposed to the CSS. This allows us to dynamicly change icon styling as needed simply by modifying our CSS. Most importantly, this allows us to recolor icons according to Jupyterlab's current theme.
+
+## How JupyterLab handles icons
+
+The @jupyterlab/ui-components package provides icons to the rest of JupyterLab, in the form of a set of `LabIcon` instances (currently about 80). All of the icons in the core JupyterLab packages are rendered using one of these `LabIcon` instances.
+
+## Using the icons in your own code
+
+You can use any of JupyterLab icons in your own code via an `import` statement. For example, to use `jupyterIcon` you would first do:
+
+```typescript
+import { jupyterIcon } from '@jupyterlab/ui-components';
+```
+
+## How to render an icon into a DOM node
+
+Icons can be added as children to any `div` or `span` nodes using the `icon.element(...)` method (where `icon` is any instance of `LabIcon`). For example, to render the Jupyter icon you could do:
+
+```typescript
+jupyterIcon.element({
+  container: elem,
+  height: '16px',
+  width: '16px',
+  marginLeft: '2px'
+});
+```
+
+where `elem` is any `HTMLElement` with a `div` or `span` tag. As shown in the above example, the icon can be styled by passing CSS parameters into `.element(...)`. Any valid CSS parameter can be used (one catch: snake case params do have to be converted to camel case: instead of `foo-bar: '8px'`, you'd need to use `fooBar: '8px'`.
+
+## How to render an icon as a React component
+
+Icons can also be rendered using React. The `icon.react` parameter holds a standard React component that will display the icon on render. Like any React component, `icon.react` can be used in various ways.
+
+For example, here is how you would add the Jupyter icon to the render tree of another React component:
+
+```jsx
+  public render() {
+    return (
+      <div className="outer">
+        <div className="inner">
+          <jupyterIcon.react tag="span" right="7px" top="5px" />
+          "and here's a text node"
+        </div>
+      </div>
+    );
+  }
+```
+
+Alternatively, you can just render the icon directly into any existing DOM node `elem` by using the `ReactDOM` module:
+
+```typescript
+ReactDOM.render(jupyterIcon.react, elem);
+```
+
+If do you use `ReactDOM` to render, and if the `elem` node is ever removed from the DOM, you'll first need to clean it up:
+
+```typescript
+ReactDOM.unmountComponentAtNode(elem);
+```
+
+This cleanup step is not a special property of `LabIcon`, but is instead needed for any React component that is rendered directly at the top level by `ReactDOM`: failure to call `unmountComponentAtNode` can result in a [memory leak](https://stackoverflow.com/a/48198011/425458).
+
+## How to create your own custom `LabIcon`
+
+You can create your own custom icon by constructing a new instance of `LabIcon`:
+
+```typescript
+export const fooIcon = new LabIcon({
+  name: 'barpkg:foo',
+  svgstr: '<svg>...</svg>'
+});
+```
+
+where `name` should be of the form "your-pkg:icon-name", and `svgstr` is the raw contents of your icon's svg file.
+
+## How to create a new `LabIcon` from an external svg file
+
+Although you can copy-and-paste an svg directly into the `LabIcon` constructor, the best practice is to keep the svg for each of your icons in its own separate svg file. You will need to have an `svg.d.ts` file at the root of your project's `src` directory:
+
+```typescript
+// svg.d.ts
+
+declare module '*.svg' {
+  const value: string;
+  export default value;
+}
+```
+
+You can then `import` the contents of an svg file:
+
+```typescript
+import fooSvgstr from 'path-to-your/foo.svg';
+
+export const fooIcon = new LabIcon({ name: 'barpkg:foo', svgstr: fooSvgstr });
+```

scripts/ci_script.sh

@@ -54,7 +54,7 @@ fi
 if [[ $GROUP == docs ]]; then
     # Verify tutorial docs build
     pushd docs
-    pip install sphinx sphinx-copybutton sphinx_rtd_theme recommonmark jsx-lexer
+    pip install -r requirements.txt
     make html
 
     # Remove internal sphinx files and use pytest-check-links on the generated html