Merge pull request #1889 from xonsh/doc_fixes

Doc fixes

docs/api/index.rst

@@ -55,7 +55,6 @@ For those of you who want the gritty details.
     platform
     lazyjson
     lazyasd
-    teepty
     openpy
     foreign_shells
     commands_cache

docs/api/teepty.rst

@@ -1,10 +0,0 @@
-.. _xonsh_teepty:
-
-******************************************************
-Tee'd Psuedo-Terminal (``xonsh.teepty``)
-******************************************************
-
-.. automodule:: xonsh.teepty
-    :members:
-    :undoc-members:
-    :inherited-members:

docs/conf.py

@@ -22,6 +22,11 @@ from xonsh.commands_cache import CommandsCache
 
 sys.path.insert(0, os.path.dirname(__file__))
 
+def setup(sphinx):
+    from xonsh.pyghooks import XonshConsoleLexer
+    sphinx.add_lexer("xonshcon", XonshConsoleLexer())
+
+
 # -- General configuration -----------------------------------------------------
 
 # Documentation is being built on readthedocs, this will be true.

docs/dependencies.rst

@@ -21,6 +21,6 @@ Xonsh currently has the following extras
 In addition, xonsh integrates with Jupyter, an in-browser REPL, enabling the use of xonsh in jupyter notebooks
 
 Development Dependencies
-------------------------
+========================
 
 If you want to develop xonsh, it is extremely recommended to install the depdencies listed in `requirements-docs.txt <https://github.com/xonsh/xonsh/blob/master/requirements-docs.txt>`_ (to generate documentation) and `requirements-tests.txt <https://github.com/xonsh/xonsh/blob/master/requirements-tests.txt>`_ (to run the test suite).

docs/linux.rst

@@ -117,7 +117,7 @@ any necessary arguments.
 The default user `~/.bashrc` file in Ubuntu 15.10 has the following snippet at
 the top, which causes the script to exit immediately if not run interactively.
 
-.. code-block:: console
+.. code-block:: bash
 
     # If not running interactively, don't do anything
     case $- in

docs/tutorial.rst

@@ -521,7 +521,7 @@ be used to generate any of the tokens in the subprocess command list.
 Thus, ``@()`` allows us to create complex commands in Python-mode and then
 feed them to a subprocess as needed.  For example:
 
-.. code-block:: xonsh
+.. code-block:: xonshcon
 
     for i in range(20):
         $[touch @('file%02d' % i)]
@@ -1432,7 +1432,7 @@ Longer scripts can be run either by specifying a filename containing the script,
 or by feeding them to xonsh via stdin.  For example, consider the following
 script, stored in ``test.xsh``:
 
-.. code-block:: xonsh
+.. code-block:: xonshcon
 
     #!/usr/bin/env xonsh
 
@@ -1484,7 +1484,7 @@ operates on a given argument, rather than on the string ``'xonsh'`` (notice how
 ``$ARGS`` and ``$ARG1`` are used):
 
 
-.. code-block:: xonsh
+.. code-block:: xonshcon
 
     #!/usr/bin/env xonsh
 
@@ -1535,7 +1535,7 @@ the normal Python syntax.  Say you had a file called ``mine.xsh``, you could,
 therefore, perform a Bash-like source into your current shell with the
 following:
 
-.. code-block:: xonsh
+.. code-block:: xonshcon
 
     from mine import *
 

docs/windows.rst

@@ -78,15 +78,15 @@ Color style
 The dark red and blue colors are completely unreadable in Windows' default
 terminal. To give new users, the best experience Xonsh automatically replaces 
 some of the dark colors with more readable alternatives (e.g. blue becomes cyan).
- The behavior is controlled with the ``$INTENSIFY_COLORS_ON_WIN``
+The behavior is controlled with the ``$INTENSIFY_COLORS_ON_WIN``
 environment variable.
 
-.. image:: _static/intensify-colors-win-false.png
+.. image:: _static/intensify-colors-on-win-false.png
    :width: 100 %
    :alt: intensify-colors-win-false
    :align: center
 
-.. image:: _static/intensify-colors-win-true.png
+.. image:: _static/intensify-colors-on-win-true.png
    :width: 100 %
    :alt: intensify-colors-win-true
    :align: center

news/doc_fixes.rst

@@ -0,0 +1,13 @@
+**Added:** None
+
+**Changed:** None
+
+**Deprecated:** None
+
+**Removed:** None
+
+**Fixed:**
+
+* Fixed a handful of sphinx errors and warnings in the docs
+
+**Security:** None