Add a Sphinx based help system, and include some initial docs on development.

web/config.py

@@ -31,6 +31,9 @@ APP_SUFFIX = 'dev'
 # Copyright string for display in the app
 APP_COPYRIGHT = 'Copyright 2014 - 2015, The pgAdmin Development Team'
 
+# Path to the online help. 
+HELP_PATH = '../../../docs/en_US/_build/html/'
+
 # DO NOT CHANGE!
 # The application version string, constructed from the components
 APP_VERSION = '%s.%s.%s-%s' % (APP_MAJOR, APP_MINOR, APP_REVISION, APP_SUFFIX)

web/pgadmin/about/hooks.py

@@ -2,7 +2,7 @@
 #
 # pgAdmin 4 - PostgreSQL Tools
 #
-# Copyright (C) 2013 - 2014, The pgAdmin Development Team
+# Copyright (C) 2013 - 2015, The pgAdmin Development Team
 # This software is released under the PostgreSQL Licence
 #
 ##########################################################################
@@ -14,8 +14,8 @@ from flask import render_template, url_for
 import config
 
 def get_help_menu_items():
-    """Return a (set) of dicts of help menu items, with name, priority, URL and 
-    onclick code."""
+    """Return a (set) of dicts of help menu items, with name, priority, URL, 
+    target and onclick code."""
     return [{'name': 'mnu_about',
              'label': 'About %s' % (config.APP_NAME), 
              'priority': 999, 

web/pgadmin/browser/nodes/CollectionNode.py

@@ -0,0 +1,14 @@
+##########################################################################
+#
+# pgAdmin 4 - PostgreSQL Tools
+#
+# Copyright (C) 2013 - 2015, The pgAdmin Development Team
+# This software is released under the PostgreSQL Licence
+#
+##########################################################################
+
+"""Base class for Collection Nodes on the browser treeview"""
+
+def get_name():
+    """Returns the display name of the collection"""
+    return ""

web/pgadmin/browser/nodes/ObjectNode.py

@@ -0,0 +1,15 @@
+##########################################################################
+#
+# pgAdmin 4 - PostgreSQL Tools
+#
+# Copyright (C) 2013 - 2015, The pgAdmin Development Team
+# This software is released under the PostgreSQL Licence
+#
+##########################################################################
+
+"""Base class for Object Nodes on the browser treeview"""
+
+def get_name():
+    """Returns the object's name"""
+    return ""
+    

web/pgadmin/browser/nodes/server_groups/hooks.py

@@ -27,7 +27,8 @@ def get_nodes():
 
     
 def get_file_menu_items():
-    """Return a (set) of dicts of file menu items, with name, label, priority and URL."""
+    """Return a (set) of dicts of file menu items, with name, priority, URL, 
+    target and onclick code."""
     return [
             {'name': 'mnu_add_server_group', 'label': 'Add a server group...', 'priority': 10, 'url': '#', 'onclick': 'add_server_group()'},
             {'name': 'mnu_delete_server_group', 'label': 'Delete server group', 'priority': 20, 'url': '#', 'onclick': 'delete_server_group()'},

web/pgadmin/browser/templates/browser/index.html

@@ -20,35 +20,35 @@
         {% if file_items is defined and file_items|count > 0 %}<li class="dropdown">
           <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">File <span class="caret"></span></a>
           <ul class="dropdown-menu" role="menu">{% for file_item in file_items %}
-            <li><a id="{{ file_item.name }}" href="{{ file_item.url }}" onclick="{{ file_item.onclick|safe }}">{{ file_item.label }}</a></li>{% endfor %}
+            <li><a id="{{ file_item.name }}" href="{{ file_item.url }}"  target="{{ file_item.target }}" onclick="{{ file_item.onclick|safe }}">{{ file_item.label }}</a></li>{% endfor %}
           </ul>
         </li>{% endif %}
 
         {% if edit_items is defined and edit_items|count > 0 %}<li class="dropdown">
           <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">Edit <span class="caret"></span></a>
           <ul class="dropdown-menu" role="menu">{% for edit_item in edit_items %}
-            <li><a id="{{ edit_item.name }}" href="{{ edit_item.url }}" onclick="{{ edit_item.onclick|safe }}">{{ edit_item.label }}</a></li>{% endfor %}
+            <li><a id="{{ edit_item.name }}" href="{{ edit_item.url }}"  target="{{ edit_item.target }}" onclick="{{ edit_item.onclick|safe }}">{{ edit_item.label }}</a></li>{% endfor %}
           </ul>
         </li>{% endif %}
         
         {% if tools_items is defined and tools_items|count > 0 %}<li class="dropdown">
           <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">Tools <span class="caret"></span></a>
           <ul class="dropdown-menu" role="menu">{% for tools_item in tools_items %}
-            <li><a id="{{ tools_item.name }}" href="{{ tools_item.url }}" onclick="{{ tools_item.onclick|safe }}">{{ tools_item.label }}</a></li>{% endfor %}
+            <li><a id="{{ tools_item.name }}" href="{{ tools_item.url }}" target="{{ tools_item.target }}" onclick="{{ tools_item.onclick|safe }}">{{ tools_item.label }}</a></li>{% endfor %}
           </ul>
         </li>{% endif %}
         
         {% if management_items is defined and management_items|count > 0 %}<li class="dropdown">
           <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">Management <span class="caret"></span></a>
           <ul class="dropdown-menu" role="menu">{% for management_item in management_items %}
-            <li><a id="{{ management_item.name }}" href="{{ management_item.url }}" onclick="{{ management_item.onclick|safe }}">{{ management_item.label }}</a></li>{% endfor %}
+            <li><a id="{{ management_item.name }}" href="{{ management_item.url }}" target="{{ management_item.target }}" onclick="{{ management_item.onclick|safe }}">{{ management_item.label }}</a></li>{% endfor %}
           </ul>
         </li>{% endif %}
         
         {% if help_items is defined and help_items|count > 0 %}<li class="dropdown">
           <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">Help <span class="caret"></span></a>
           <ul class="dropdown-menu" role="menu">{% for help_item in help_items %}
-            <li><a id="{{ help_item.name }}" href="{{ help_item.url }}" onclick="{{ help_item.onclick|safe }}">{{ help_item.label }}</a></li>{% endfor %}
+            <li><a id="{{ help_item.name }}" href="{{ help_item.url }}" target="{{ help_item.target }}" onclick="{{ help_item.onclick|safe }}">{{ help_item.label }}</a></li>{% endfor %}
           </ul>
         </li>{% endif %}
 

web/pgadmin/help/hooks.py

@@ -0,0 +1,23 @@
+##########################################################################
+#
+# pgAdmin 4 - PostgreSQL Tools
+#
+# Copyright (C) 2013 - 2015, The pgAdmin Development Team
+# This software is released under the PostgreSQL Licence
+#
+##########################################################################
+
+"""Browser integration functions for the Help module."""
+
+from flask import url_for
+
+import config
+
+def get_help_menu_items():
+    """Return a (set) of dicts of help menu items, with name, priority, URL, 
+    target and onclick code."""
+    return [{'name': 'mnu_contents',
+             'label': 'Contents', 
+             'priority': 1, 
+             'target': '_new',
+             'url': url_for('help.static', filename='index.html') }]

web/pgadmin/help/views.py

@@ -0,0 +1,22 @@
+##########################################################################
+#
+# pgAdmin 4 - PostgreSQL Tools
+#
+# Copyright (C) 2013 - 2015, The pgAdmin Development Team
+# This software is released under the PostgreSQL Licence
+#
+##########################################################################
+
+"""A blueprint module implementing the pgAdmin help system."""
+MODULE_NAME = 'help'
+
+from flask import Blueprint
+from flaskext.gravatar import Gravatar
+from flask.ext.security import login_required
+from flask.ext.login import current_user
+from inspect import getmoduleinfo, getmembers
+
+import config
+
+# Initialise the module
+blueprint = Blueprint(MODULE_NAME, __name__, static_url_path='/help', static_folder=config.HELP_PATH)

web/pgadmin/test/hooks.py

@@ -12,7 +12,8 @@
 from flask import render_template, url_for
 
 def get_file_menu_items():
-    """Return a (set) of dicts of file menu items, with name, label, priority and URL."""
+    """Return a (set) of dicts of file menu items, with name, priority, URL, 
+    target and onclick code."""
     return [
             {'name': 'mnu_generate_test_html', 'label': 'Generated Test HTML', 'priority': 100, 'url': url_for('test.generated')},
             {'name': 'mnu_test_alert', 'label': 'Test Alert', 'priority': 200, 'url': '#', 'onclick': 'test_alert()'},