docs build

CHANGELOG.rst

@@ -18,7 +18,7 @@ v0.7.7
 
 **Changed:**
 
-* Improved iteration over virtual environments in Vox.__iter__
+* Improved iteration over virtual environments in ``Vox.__iter__``
 
 
 **Fixed:**
@@ -117,7 +117,7 @@ v0.7.4
 
 **Fixed:**
 
-- Fixed a bug with converting new PTK2 colors names to old names when using PTK1 or Jupyter 
+* Fixed a bug with converting new PTK2 colors names to old names when using PTK1 or Jupyter
     as the shell type.
 * ``CommandsCache.locate_binary()`` will now properly return None when
   ``ignore_alias=False`` and the command is only a functional alias,
@@ -137,11 +137,11 @@ v0.7.3
 
 * Add the ``PROMPT_TOOLKIT_COLOR_DEPTH`` environment to xonsh default environment.
   Possible values are ``DEPTH_1_BIT``/``MONOCHROME``,
-  ``DEPTH_4_BIT``/``ANSI_COLORS_ONLY``, ``DEPTH_8_BIT``/``DEFAULT``, or ``DEPTH_24_BIT``/``TRUE_COLOR``. 
+  ``DEPTH_4_BIT``/``ANSI_COLORS_ONLY``, ``DEPTH_8_BIT``/``DEFAULT``, or ``DEPTH_24_BIT``/``TRUE_COLOR``.
   Note: not all terminals support all color depths.
 * New way to fix unreadable default terminal colors on Windows 10. Windows 10
   now supports true color in the terminal, so if prompt toolkit 2 is
-  installed Xonsh will use a style with hard coded colors instead of the 
+  installed Xonsh will use a style with hard coded colors instead of the
   default terminal colors. This will give the same color experience as on linux an mac.
   The behaviour can be disabled with ``$INTENSIFY_COLORS_ON_WIN``
   environment variable.
@@ -150,9 +150,9 @@ v0.7.3
 
 **Changed:**
 
-* All ansicolor names used in styles have ben updated to the color names used by prompt_toolkit 2. 
-  The new names are are much easier to understand 
-  (e.g. ``ansicyan``/``ansibrightcyan`` vs. the old ``#ansiteal``/``#ansiturquoise``). The names are automatically 
+* All ansicolor names used in styles have ben updated to the color names used by prompt_toolkit 2.
+  The new names are are much easier to understand
+  (e.g. ``ansicyan``/``ansibrightcyan`` vs. the old ``#ansiteal``/``#ansiturquoise``). The names are automatically
   translated back when using prompt_toolkit 1.
 
 

docs/api/index.rst

@@ -44,10 +44,6 @@ For those of you who want the gritty details.
     shell
     base_shell
     readline_shell
-    ptk/shell
-    ptk/history
-    ptk/completer
-    ptk/key_bindings
     ptk2/shell
     ptk2/history
     ptk2/completer
@@ -92,3 +88,12 @@ For those of you who want the gritty details.
     mplhooks
     vox
 
+**Pending Deprecation:**
+
+.. toctree::
+    :maxdepth: 1
+
+    ptk/shell
+    ptk/history
+    ptk/completer
+    ptk/key_bindings

docs/api/ptk/completer.rst

@@ -4,7 +4,4 @@
 Prompt Toolkit Completer (``xonsh.ptk.completer``)
 *************************************************************
 
-.. automodule:: xonsh.ptk.completer
-    :members:
-    :undoc-members:
-    :inherited-members:
+.. warning:: This module is pending deprecation.

docs/api/ptk/history.rst

@@ -4,7 +4,4 @@
 Prompt Toolkit History Object (``xonsh.ptk.history``)
 ****************************************************************
 
-.. automodule:: xonsh.ptk.history
-    :members:
-    :undoc-members:
-    :inherited-members:
+.. warning:: This module is pending deprecation.

docs/api/ptk/key_bindings.rst

@@ -4,7 +4,5 @@
 Prompt Toolkit Key Bindings (``xonsh.ptk.key_bindings``)
 **********************************************************
 
-.. automodule:: xonsh.ptk.key_bindings
-    :members:
-    :undoc-members:
-    :inherited-members:
+.. warning:: This module is pending deprecation.
+

docs/api/ptk/shell.rst

@@ -4,7 +4,4 @@
 Prompt Toolkit Shell (``xonsh.ptk.shell``)
 ******************************************************
 
-.. automodule:: xonsh.ptk.shell
-    :members:
-    :undoc-members:
-    :inherited-members:
+.. warning:: This module is pending deprecation.

requirements-docs.txt

@@ -8,3 +8,4 @@ psutil
 pyzmq
 matplotlib
 doctr
+tornado