update docs

docs/source/conf.py

@@ -12,11 +12,11 @@
 # serve to show the default.
 
 import sys, os
-import sphinx_rtd_theme
+#import sphinx_rtd_theme
 
-html_theme = "sphinx_rtd_theme"
+html_theme = "bizstyle"
 
-html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+#html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 
 sys.path.append(os.path.join(os.path.dirname(__file__), '../../'))
 

docs/source/index.rst

@@ -18,6 +18,7 @@ API Documentation
     pypsi.commands.rst
     pypsi.plugins.rst
     pypsi.shell.rst
+    pypsi.completers.rst
     pypsi.core.rst
     pypsi.cmdline.rst
     pypsi.namespace.rst

docs/source/pypsi.ansi.rst

@@ -1,9 +1,5 @@
 pypsi.ansi - ANSI Escape Code Support
 =====================================
 
-.. toctree::
-    :numbered:
-
-
 .. automodule:: pypsi.ansi
     :members:

docs/source/pypsi.cmdline.rst

@@ -1,10 +1,6 @@
 pypsi.cmdline - User input processing
 =====================================
 
-.. toctree::
-    :numbered:
-    :maxdepth: 2
-
 .. automodule:: pypsi.cmdline
 
 

docs/source/pypsi.commands.rst

@@ -5,13 +5,6 @@ Pypsi Builtin Commands
 
 Pypsi ships with several commands that would be useful for any shell.
 
-.. toctree::
-    :numbered:
-    :maxdepth: 2
-
-
-
-
 .. autoclass:: pypsi.commands.echo.EchoCommand
     :members:
 

docs/source/pypsi.completers.rst

@@ -0,0 +1,5 @@
+pypsi.completers - Core tab completion functions
+=================================================
+
+.. automodule:: pypsi.completers
+    :members:

docs/source/pypsi.core.rst

@@ -1,10 +1,6 @@
 pypsi.core - Core classes for pluggable features
 ================================================
 
-.. toctree::
-    :numbered:
-
-
 .. automodule:: pypsi.core
 
 

docs/source/pypsi.format.rst

@@ -1,9 +1,5 @@
 pypsi.format - Stream output formatting
 =======================================
 
-.. toctree::
-    :numbered:
-
-
 .. automodule:: pypsi.format
     :members:

docs/source/pypsi.namespace.rst

@@ -1,9 +1,5 @@
 pypsi.namespace - Arbitrary attribute storage classes
 =====================================================
 
-.. toctree::
-    :numbered:
-
-
 .. automodule:: pypsi.namespace
     :members:

docs/source/pypsi.plugins.rst

@@ -4,10 +4,6 @@ Pypsi Builtin Plugins
 
 Pypsi ships with several useful plugins that enhance the shell.
 
-.. toctree::
-    :numbered:
-    :maxdepth: 2
-
 .. automodule:: pypsi.plugins
 
 

docs/source/pypsi.shell.rst

@@ -2,10 +2,6 @@
 pypsi.shell - Pypsi Shell
 =========================
 
-.. toctree::
-    :numbered:
-
-
 .. automodule:: pypsi.shell
     :members:
 

docs/source/pypsi.utils.rst

@@ -1,9 +1,5 @@
 pypsi.utils - Utility functions
 ===============================
 
-.. toctree::
-    :numbered:
-
-
 .. automodule:: pypsi.utils
     :members:

docs/source/pypsi.wizard.rst

@@ -1,9 +1,5 @@
 pypsi.wizard - Prompt Wizards
 =============================
 
-.. toctree::
-    :numbered:
-
-
 .. automodule:: pypsi.wizard
     :members:

pypsi/cmdline.py

@@ -508,8 +508,8 @@ def __call__(self, shell):
     def should_continue(self, prev_rc):
         '''
         :returns: whether this invocation is chained and, using the previous
-        invocation's return code, determine if the next command in the chain
-        should be executed.
+            invocation's return code, determine if the next command in the
+            chain should be executed.
         '''
 
         return (

pypsi/completers.py

@@ -26,16 +26,18 @@ def command_completer(parser, shell, args, prefix, case_sensitive=False):
     '''
     Completion function that can tab complete options, options' values,
     and positional parameters. Shell, args, and prefix should be the same
-    params as passed to the pypsi.core.Command.complete() function
-    :param parser: A PypsiArgParser object OR an action object returned
-                   from PypsiArgParser.add_subparsers()
-    :param pypsi.shell.Shell shell:  The current Shell object
+    params as passed to the :meth:`pypsi.core.Command.complete` function
+
+    :param parser: A PypsiArgParser object or an action object returned
+        from :meth:`PypsiArgParser.add_subparsers`
+    :param pypsi.shell.Shell shell: The current Shell object
     :param list args: The full list of current CLI args
     :param str prefix: The partial arg being completed
     :param bool case_sensitive: Whether the prefix will be completed
-                           in a case sensitive manner
+        in a case sensitive manner
     :return list: A list of possible options based on the prefix
     '''
+
     cmd_parser = None
     offset = 0
     completions = []

pypsi/core.py

@@ -387,7 +387,7 @@ def pypsi_print(*args, sep=' ', end='\n', file=None, flush=True, width=None,
     '''
     Wraps the functionality of the Python builtin `print` function. The
     :meth:`pypsi.shell.Shell.bootstrap` overrides the Python :meth:`print`
-    function with :meth:`pypsi_print`.
+    function with ``pypsi_print``.
 
     :param str sep: string to print between arguments
     :param str end: string to print at the end of the output

pypsi/shell.py

@@ -197,6 +197,7 @@ def on_tokenize(self, tokens, origin):
     def include(self, file):
         '''
         Read commands from a file and execute them line by line
+
         :param file file: File object to read commands from
         :return int: 0 if error free; 1 if an error occurred
         '''