help provider (for local help)

Author: DonJayamanne

package.json

@@ -45,7 +45,8 @@
     "onCommand:python.execSelectionInTerminal",
     "onCommand:jupyter.runSelectionLine",
     "onCommand:jupyter.execCurrentCell",
-    "onCommand:jupyter.execCurrentCellAndAdvance"
+    "onCommand:jupyter.execCurrentCellAndAdvance",
+    "onCommand:python.displayHelp"
   ],
   "main": "./out/client/extension",
   "contributes": {
@@ -130,6 +131,11 @@
         "command": "jupyter:gotToNextCell",
         "title": "Go to next cell",
         "category": "Jupyter"
+      },
+      {
+        "command": "python.displayHelp",
+        "title": "Help",
+        "category": "Python"
       }
     ],
     "menus": {
@@ -789,4 +795,4 @@
     "vscode": "^0.11.0",
     "webpack": "^1.13.2"
   }
-}
+}

src/client/common/constants.ts

@@ -73,9 +73,10 @@ export namespace LinterErrors {
 }
 
 export namespace Documentation {
+    export const Home = '/docs/python-path/';
     export namespace Jupyter {
-        export const GettingStarted = "/docs/jupyter_getting-started/";
-        export const Examples = "/docs/jupyter_examples/";
-        export const Setup = "/docs/jupyter_prerequisites/";
+        export const GettingStarted = '/docs/jupyter_getting-started/';
+        export const Examples = '/docs/jupyter_examples/';
+        export const Setup = '/docs/jupyter_prerequisites/';
     }
 }

src/client/helpProvider.ts

@@ -5,10 +5,11 @@ import {Disposable} from 'vscode';
 import * as path from 'path';
 import * as http from 'http';
 import {createDeferred} from './common/helpers';
+import {Documentation} from './common/constants';
 const nodeStatic = require('node-static');
 
 let serverAddress = "http://localhost:8080";
-let helpPageToDisplay = "/docs/jupyter/";
+let helpPageToDisplay = Documentation.Home;
 export class TextDocumentContentProvider extends Disposable implements vscode.TextDocumentContentProvider {
     private _onDidChange = new vscode.EventEmitter<vscode.Uri>();
     private lastUri: vscode.Uri;
@@ -49,11 +50,18 @@ export class HelpProvider {
     private disposables: Disposable[] = [];
     constructor() {
         const textProvider = new TextDocumentContentProvider();
-        this.disposables.push(vscode.workspace.registerTextDocumentContentProvider(helpSchema, textProvider));
+        this.disposables.push(vscode.workspace.registerTextDocumentContentProvider(helpSchema, textProvider));        
         this.disposables.push(vscode.commands.registerCommand('python.displayHelp', (page: string) => {
             this.startServer().then(port => {
-                helpPageToDisplay = page;
-                vscode.commands.executeCommand('vscode.previewHtml', previewUri, vscode.ViewColumn.Two, 'Help');
+                let viewColumn = vscode.ViewColumn.Two;
+                if (!page || typeof page !== 'string' || page.length === 0) {
+                    helpPageToDisplay = Documentation.Home;
+                    viewColumn = vscode.ViewColumn.One;
+                }
+                else {
+                    helpPageToDisplay = page;
+                }
+                vscode.commands.executeCommand('vscode.previewHtml', previewUri, viewColumn, 'Help');
             });
         }));
     }