Browse Source

Fix JLab docs to point to new generated typedoc docs.

Jason Grout 4 years ago
parent
commit
03785970b3

+ 1 - 1
docs/source/developer/repo.rst

@@ -123,4 +123,4 @@ TypeDoc Theming: ``typedoc-theme``
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 A small theme used to help render our 
-`TypeDoc <http://jupyterlab.github.io/jupyterlab/index.html>`__ documentation. 
+`TypeDoc <../api/index.html>`__ documentation.

+ 10 - 10
docs/source/extension/documents.rst

@@ -18,21 +18,21 @@ is backed by a file stored on disk (i.e. uses Contents API).
 Overview of document architecture
 ---------------------------------
 
-A 'document' in JupyterLab is represented by a model instance implementing the `IModel <https://jupyterlab.github.io/jupyterlab/interfaces/_docregistry_src_index_.documentregistry.imodel.html>`__ interface. The model interface is intentionally fairly small, and concentrates on representing the data in the document and signaling changes to that data. Each model has an associated `context <https://jupyterlab.github.io/jupyterlab/interfaces/_docregistry_src_index_.documentregistry.icontext.html>`__ instance as well. The context for a model is the bridge between the internal data of the document, stored in the model, and the file metadata and operations possible on the file, such as save and revert. Since many objects will need both the context and the model, the context contains a reference to the model as its `.model` attribute.
+A 'document' in JupyterLab is represented by a model instance implementing the `IModel <../api/interfaces/docregistry.documentregistry.imodel.html>`__ interface. The model interface is intentionally fairly small, and concentrates on representing the data in the document and signaling changes to that data. Each model has an associated `context <../api/interfaces/docregistry.documentregistry.icontext.html>`__ instance as well. The context for a model is the bridge between the internal data of the document, stored in the model, and the file metadata and operations possible on the file, such as save and revert. Since many objects will need both the context and the model, the context contains a reference to the model as its `.model` attribute.
 
 A single file path can have multiple different models (and hence different contexts) representing the file. For example, a notebook can be opened with a notebook model and with a text model. Different models for the same file path do not directly communicate with each other.
 
-`Document widgets <https://jupyterlab.github.io/jupyterlab/classes/_docregistry_src_index_.documentregistry.html>`__ represent a view of a document model. There can be multiple document widgets associated with a single document model, and they naturally stay in sync with each other since they are views on the same underlying data model.
+`Document widgets <../api/classes/docregistry.documentregistry-1.html>`__ represent a view of a document model. There can be multiple document widgets associated with a single document model, and they naturally stay in sync with each other since they are views on the same underlying data model.
 
 
 The `Document
-Registry <https://jupyterlab.github.io/jupyterlab/classes/_docregistry_src_index_.documentregistry.html>`__
+Registry <../api/classes/docregistry.documentregistry-1.html>`__
 is where document types and factories are registered. Plugins can
 require a document registry instance and register their content types
 and providers.
 
 The `Document
-Manager <https://jupyterlab.github.io/jupyterlab/classes/_docmanager_src_index_.documentmanager.html>`__
+Manager <../api/classes/docmanager.documentmanager-1.html>`__
 uses the Document Registry to create models and widgets for documents.
 The Document Manager handles the lifecycle of documents for the application.
 
@@ -46,7 +46,7 @@ Document Registry
 -  widget factories for specific model factories
 -  widget extension factories
 
-`Widget Factories <https://jupyterlab.github.io/jupyterlab/classes/_docregistry_src_index_.documentregistry.html#addwidgetfactory>`__
+`Widget Factories <../api/classes/docregistry.documentregistry-1.html#addwidgetfactory>`__
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Create a widget for a given file.
@@ -55,7 +55,7 @@ Create a widget for a given file.
 
 -  The notebook widget factory that creates NotebookPanel widgets.
 
-`Model Factories <https://jupyterlab.github.io/jupyterlab/classes/_docregistry_src_index_.documentregistry.html#addmodelfactory>`__
+`Model Factories <../api/classes/docregistry.documentregistry-1.html#addmodelfactory>`__
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Create a model for a given file.
@@ -63,7 +63,7 @@ Create a model for a given file.
 Models are generally differentiated by the contents options used to
 fetch the model (e.g. text, base64, notebook).
 
-`Widget Extension Factories <https://jupyterlab.github.io/jupyterlab/classes/_docregistry_src_index_.documentregistry.html#addwidgetextension>`__
+`Widget Extension Factories <../api/classes/docregistry.documentregistry-1.html#addwidgetextension>`__
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Adds additional functionality to a widget type. An extension instance is
@@ -75,10 +75,10 @@ functionality to each widget or observe the widget and/or its context.
 -  The ipywidgets extension that is created for NotebookPanel widgets.
 -  Adding a button to the toolbar of each NotebookPanel widget.
 
-`File Types <https://jupyterlab.github.io/jupyterlab/classes/_docregistry_src_index_.documentregistry.html#addfiletype>`__
+`File Types <../api/classes/docregistry.documentregistry-1.html#addfiletype>`__
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-`Document Models <https://jupyterlab.github.io/jupyterlab/interfaces/_docregistry_src_index_.documentregistry.imodel.html>`__
+`Document Models <../api/interfaces/docregistry.documentregistry.imodel.html>`__
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Created by the model factories and passed to widget factories and widget
@@ -87,7 +87,7 @@ data of 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 <https://jupyterlab.github.io/jupyterlab/interfaces/_docregistry_src_index_.documentregistry.icontext.html>`__
+`Document Contexts <../api/interfaces/docregistry.documentregistry.icontext.html>`__
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Created by the Document Manager and passed to widget factories and

+ 2 - 2
docs/source/extension/extension_dev.rst

@@ -37,7 +37,7 @@ API Reference Documentation
 
 Here is some autogenerated API documentation for JupyterLab and Lumino packages:
 
-- `JupyterLab API Documentation <https://jupyterlab.github.io/jupyterlab/>`_
+- `JupyterLab API Documentation <../api/>`_
 - `Lumino API Documentation <https://jupyterlab.github.io/lumino/>`_
 
 
@@ -154,7 +154,7 @@ Mime Renderer Plugins
 Mime Renderer plugins are a convenience for creating a plugin
 that can render mime data in a notebook and files of the given mime type. Mime renderer plugins are more declarative and more restricted than standard plugins.
 A mime renderer plugin is an object with the fields listed in the 
-`rendermime-interfaces IExtension <https://jupyterlab.github.io/jupyterlab/interfaces/_rendermime_interfaces_src_index_.irendermime.iextension.html>`__
+`rendermime-interfaces IExtension <../api/interfaces/rendermime_interfaces.irendermime.iextension.html>`__
 object.
 
 JupyterLab has a `pdf mime renderer extension <https://github.com/jupyterlab/jupyterlab/tree/master/packages/pdf-extension>`__, for example. In core JupyterLab, this is used to view pdf files and view pdf data mime data in a notebook.

+ 2 - 2
docs/source/extension/extension_points.rst

@@ -10,7 +10,7 @@ A list of common core tokens that extension authors can request is given in :ref
 Following the list of core tokens is a guide for using some of JupyterLab's most commonly-used extension points.
 However, it is not an exhaustive account of how to extend the application components,
 and more detailed descriptions of their public APIs may be found in the
-`JupyterLab <http://jupyterlab.github.io/jupyterlab/index.html>`__ and
+`JupyterLab <../api/index.html>`__ and
 `Lumino <http://jupyterlab.github.io/lumino/index.html>`__ API documentation.
 
 .. contents:: Table of contents
@@ -407,7 +407,7 @@ Jupyter Front-End Shell
 -----------------------
 
 The Jupyter front-end
-`shell <https://jupyterlab.github.io/jupyterlab/interfaces/_application_src_index_.jupyterfrontend.ishell.html>`__
+`shell <../api/interfaces/application.jupyterfrontend.ishell.html>`__
 is used to add and interact with content in the application. The ``IShell``
 interface provides an ``add()`` method for adding widgets to the application.
 In JupyterLab, the application shell consists of:

+ 17 - 17
docs/source/extension/notebook.rst

@@ -19,9 +19,9 @@ The most complicated plugin included in the **JupyterLab application**
 is the **Notebook plugin**.
 
 The
-`NotebookWidgetFactory <https://jupyterlab.github.io/jupyterlab/classes/_notebook_src_index_.notebookwidgetfactory.html>`__
+`NotebookWidgetFactory <../api/classes/notebook.notebookwidgetfactory-1.html>`__
 constructs a new
-`NotebookPanel <https://jupyterlab.github.io/jupyterlab/classes/_notebook_src_index_.notebookpanel.html>`__
+`NotebookPanel <../api/classes/notebook.notebookpanel-1.html>`__
 from a model and populates the toolbar with default widgets.
 
 Structure of the Notebook plugin
@@ -34,11 +34,11 @@ Model
 ^^^^^
 
 The
-`NotebookModel <https://jupyterlab.github.io/jupyterlab/classes/_notebook_src_index_.notebookmodel.html>`__
+`NotebookModel <../api/classes/notebook.notebookmodel-1.html>`__
 contains an observable list of cells.
 
 A `cell
-model <https://jupyterlab.github.io/jupyterlab/classes/_cells_src_index_.cellmodel.html>`__
+model <../api/classes/cells.cellmodel-1.html>`__
 can be:
 
 -  a code cell
@@ -65,7 +65,7 @@ Metadata
 
 The notebook model and the cell model (i.e. notebook cells) support
 getting and setting metadata through an
-`IObservableJSON <https://jupyterlab.github.io/jupyterlab/modules/_observables_src_index_.iobservablejson.html>`__
+`IObservableJSON <../api/modules/observables.iobservablejson.html>`__
 object. You can use this to get and set notebook/cell metadata,
 as well as subscribe to changes to it.
 
@@ -77,9 +77,9 @@ a new NotebookPanel from the model. The NotebookPanel widget is added to
 the DockPanel. The **NotebookPanel** contains:
 
 -  a
-   `Toolbar <https://jupyterlab.github.io/jupyterlab/classes/_apputils_src_index_.toolbar.html>`__
+   `Toolbar <../api/classes/apputils.toolbar-1.html>`__
 -  a `Notebook
-   widget <https://jupyterlab.github.io/jupyterlab/classes/_notebook_src_index_.notebook.html>`__.
+   widget <../api/classes/notebook.notebook-2.html>`__.
 
 The NotebookPanel also adds completion logic.
 
@@ -96,7 +96,7 @@ Higher level actions using NotebookActions
 """"""""""""""""""""""""""""""""""""""""""
 
 Higher-level actions are contained in the
-`NotebookActions <https://jupyterlab.github.io/jupyterlab/classes/_notebook_src_index_.notebookactions.html>`__
+`NotebookActions <../api/classes/notebook.notebookactions-1.html>`__
 namespace, which has functions, when given a notebook widget, to run a
 cell and select the next cell, merge or split cells at the cursor,
 delete selected cells, etc.
@@ -105,25 +105,25 @@ Widget hierarchy
 """"""""""""""""
 
 A Notebook widget contains a list of `cell
-widgets <https://jupyterlab.github.io/jupyterlab/classes/_cells_src_index_.cell.html>`__,
+widgets <../api/classes/cells.cell-1.html>`__,
 corresponding to the cell models in its cell list.
 
 -  Each cell widget contains an
-   `InputArea <https://jupyterlab.github.io/jupyterlab/classes/_cells_src_index_.inputarea.html>`__,
+   `InputArea <../api/classes/cells.inputarea-1.html>`__,
 
    -  which contains n
-      `CodeEditorWrapper <https://jupyterlab.github.io/jupyterlab/classes/_codeeditor_src_index_.codeeditorwrapper.html>`__,
+      `CodeEditorWrapper <../api/classes/codeeditor.codeeditorwrapper-1.html>`__,
 
       -  which contains a JavaScript CodeMirror instance.
 
 A
-`CodeCell <https://jupyterlab.github.io/jupyterlab/classes/_cells_src_index_.codecell.html>`__
+`CodeCell <../api/classes/cells.codecell-1.html>`__
 also contains an
-`OutputArea <https://jupyterlab.github.io/jupyterlab/classes/_outputarea_src_index_.outputarea.html>`__.
+`OutputArea <../api/classes/outputarea.outputarea-2.html>`__.
 An OutputArea is responsible for rendering the outputs in the
-`OutputAreaModel <https://jupyterlab.github.io/jupyterlab/classes/_outputarea_src_index_.outputareamodel.html>`__
+`OutputAreaModel <../api/classes/outputarea.outputareamodel-1.html>`__
 list. An OutputArea uses a notebook-specific
-`RenderMimeRegistry <https://jupyterlab.github.io/jupyterlab/classes/_rendermime_src_index_.rendermimeregistry.html>`__
+`RenderMimeRegistry <../api/classes/rendermime.rendermimeregistry-1.html>`__
 object to render ``display_data`` output messages.
 
 Rendering output messages
@@ -262,9 +262,9 @@ intrinsic relation between *lumino widgets* and *ipython widgets*.
 
 The *ipywidgets* extension registers a factory for a notebook *widget*
 extension using the `Document
-Registry <https://jupyterlab.github.io/jupyterlab/classes/_docregistry_src_index_.documentregistry.html>`__.
+Registry <../api/classes/docregistry.documentregistry-1.html>`__.
 The ``createNew()`` function is called with a NotebookPanel and
-`DocumentContext <https://jupyterlab.github.io/jupyterlab/interfaces/_docregistry_src_index_.documentregistry.icontext.html>`__.
+`DocumentContext <../api/interfaces/docregistry.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

+ 1 - 1
docs/source/extension/ui_components.rst

@@ -12,7 +12,7 @@
 Reusing JupyterLab UI
 =====================
 
-The `@jupyterlab/ui-components <https://jupyterlab.github.io/jupyterlab/modules/_ui_components_src_index_.html>`__
+The `@jupyterlab/ui-components <../api/modules/ui_components.html>`__
 package provides UI elements that are widely used in JupyterLab core,
 and that can be reused in your own extensions.