Browse Source

Update links

Carol Willing 8 years ago
parent
commit
f696974834

+ 6 - 0
.idea/jsLibraryMappings.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="JavaScriptLibraryMappings">
+    <file url="file://$PROJECT_DIR$" libraries="{jupyterlab/node_modules}" />
+  </component>
+</project>

+ 6 - 0
.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$" vcs="Git" />
+  </component>
+</project>

+ 1 - 1
tutorial/adding_content.md

@@ -15,7 +15,7 @@ files: `npm install -g tsd`.
 - If creating CSS, import them in `src/default-themes/index.css`.
 - The `index.ts` file should have the core logic for the plugin.  In
 this case, it should create a widget and widget factory for rendering geojson 
-files (see [Documents](./documents.md)).
+files (see [Documents](documents.html)).
 - The `plugin.ts` file should create the extension and add the content
 to the application.  In this case registering the widget factory using
 the document registry.

+ 3 - 3
tutorial/documents.md

@@ -4,7 +4,7 @@ JupyterLab can be extended in two ways via:
 
 - application plugins (top level): Application plugins extend the
   functionality of JupyterLab itself, and we cover them in the
-  [Plugins](./plugins.md) tutorial focuses.
+  [Plugins](plugins.html) tutorial focuses.
 - **document widget extensions (lower level):** Document widget extensions extend
   the functionality of document widgets added to the application, and we cover
   them in this section.
@@ -65,7 +65,7 @@ Intended for create quick launch file creators.
 The default use will be for the "create new" dropdown in the file browser,
 giving list of items that can be created with default options  (e.g. "Python 3 Notebook").
 
-### [Document Models](http://jupyterlab.github.io/jupyterlab/interfaces/_docregistry_interfaces_.idocumentmodel.html)
+### [Document Models](http://jupyterlab.github.io/jupyterlab/interfaces/_docregistry_registry_.documentregistry.imodel.html)
 
 Created by the model factories and passed to widget factories and widget
 extension factories.  Models are the way in which we interact with the data of
@@ -73,7 +73,7 @@ a document.  For a simple text file, we typically only use the
 `to/fromString()` methods.  A more complex document like a Notebook
 contains more points of interaction like the Notebook metadata.
 
-### [Document Contexts](http://jupyterlab.github.io/jupyterlab/interfaces/_docregistry_interfaces_.idocumentcontext.html)
+### [Document Contexts](http://jupyterlab.github.io/jupyterlab/interfaces/_docregistry_registry_.documentregistry.icontext.html)
 
 Created by the Document Manager and passed to widget factories and
 widget extensions.  The context contains the model as one of its properties

+ 5 - 3
tutorial/environment.yml

@@ -1,7 +1,9 @@
 name: lab_tutorial
+channels:
+  - conda-forge
 dependencies:
-- python=3.5
+- python=3
+- sphinx>1.4
 - sphinx_rtd_theme
 - pip:
-  - sphinx>1.4
-  - recommonmark
+  - recommonmark==0.4.0

+ 2 - 2
tutorial/examples.md

@@ -24,7 +24,7 @@ To run a particular example, navigate to the example's subdirectory in the
 The filebrowser example provides a stand-alone implementation of a 
 filebrowser. Here's what the filebrowser's user interface looks like:
 
-![filebrowser user interface](./filebrowser_example.png)
+![filebrowser user interface](filebrowser_example.png)
 
 Let's take a closer look at the source code in ``examples/filebrowser``.
 
@@ -33,7 +33,7 @@ Let's take a closer look at the source code in ``examples/filebrowser``.
 The filebrowser in ``examples/filebrowser`` is comprised by a handful of files and
 the ``src`` directory:
 
-![filebrowser source code](./filebrowser_source.png)
+![filebrowser source code](filebrowser_source.png)
 
 The filebrowser example has two key source files:
 

+ 1 - 1
tutorial/labextensions.md

@@ -1,6 +1,6 @@
 # JupyterLab Extensions
 
-A JupyterLab extension provides additional, optional functionality to JupyterLab's built-in capabilities. An extension is a module that provides one or more [plugins](./plugins.md) to the JupyterLab application. To streamline third-party development of extensions, this library provides a build script for generating third party extension JavaScript bundles.
+A JupyterLab extension provides additional, optional functionality to JupyterLab's built-in capabilities. An extension is a module that provides one or more [plugins](plugins.html) to the JupyterLab application. To streamline third-party development of extensions, this library provides a build script for generating third party extension JavaScript bundles.
 
 For information on creating a lab extension, please see the documentation for
 the [@jupyterlab/extension-builder](https://github.com/jupyterlab/extension-builder).

+ 3 - 3
tutorial/notebook.md

@@ -2,7 +2,7 @@
 
 ## Background
 
-[JupyterLab Walkthrough June 16, 2016 YouTube video](https://youtu.be/4Qm6oD_Rlw8?t=55m19s)
+[JupyterLab Walkthrough June 16, 2016 YouTube video](https://www.youtube.com/watch?v=4Qm6oD_Rlw8&feature=youtu.be&t=55m19s)
 
 The most complicated plugin included in the **JupyterLab application** is the
 **Notebook plugin**.
@@ -202,8 +202,8 @@ will be referred to as *ipywidgets*. There is no intrinsic relation between
 **phosphor widgets** and *ipython widgets*.
 
 The *ipywidgets* extension registers a factory for a notebook **widget** extension
-using the [Document Registry](http://jupyterlab.github.io/jupyterlab/classes/_docregistry_registry_.documentregistry.html#registermodelfactory).
-The `createNew()` function is called with a NotebookPanel and [DocumentContext](http://jupyterlab.github.io/jupyterlab/interfaces/_docregistry_interfaces_.idocumentcontext.html).
+using the [Document Registry](http://jupyterlab.github.io/jupyterlab/classes/_docregistry_registry_.documentregistry.html).
+The `createNew()` function is called with a NotebookPanel and [DocumentContext](http://jupyterlab.github.io/jupyterlab/interfaces/_docregistry_registry_.documentregistry.icontext.html).
 The plugin then creates a ipywidget manager (which uses the context to
 interact the kernel and kernel's comm manager). The plugin then registers an
 ipywidget renderer with the notebook instance's rendermime (which is specific

+ 2 - 2
tutorial/patterns.md

@@ -41,7 +41,7 @@ to declutter the class definition.
 
 The "Private" module namespace is used to group variables and
 functions that are not intended to be exported and may have
-otherwise existed as module-level variables and functions.  
+otherwise existed as module-level variables and functions.
 The use of the namespace also makes it clear when a variable access
 is to an imported name or from the module itself.  Finally,
 the namespace allows the entire section to be collapsed in
@@ -111,7 +111,7 @@ For public API, we have three options: JavaScript `Array`,
 
 Prefer an `Array` for:
 - A return value is the result of a newly allocated array, to avoid the 
-extra allocation of an iterator.  
+extra allocation of an iterator.
 - A signal payload.
 - A public attribute that is inherently static.  Use `.slice()` to
 make sure the internal value cannot be mutated by the consumer.

+ 1 - 1
tutorial/repo.md

@@ -7,7 +7,7 @@ The `jupyterlab/jupyterlab` repository contains two packages:
 
 Th npm package and the Python package are both named `jupyterlab`.
 
-See the [Contributing Guidelines](https://github.com/jupyterlab/jupyterlab/CONTRIBUTING.md) for developer installation instructions.
+See the [Contributing Guidelines](https://github.com/jupyterlab/jupyterlab/blob/master/CONTRIBUTING.md) for developer installation instructions.
 
 
 ## Directories