Merge pull request #3560 from ccordoba12/update-docs

Update documentation

README.md

@@ -71,12 +71,11 @@ The easiest way to install Spyder is:
 
 ### On Windows:
 
-- Or using one of these scientific Python distributions:
-  1. [Anaconda](http://continuum.io/downloads)
-  2. [WinPython](https://winpython.github.io/)
-  3. [Python(x,y)](http://python-xy.github.io)
-- Using one of our executable installers, which can be found
-  [here](https://github.com/spyder-ide/spyder/releases).
+Using one (and only one) of these scientific Python distributions:
+
+1. [Anaconda](http://continuum.io/downloads)
+2. [WinPython](https://winpython.github.io/)
+3. [Python(x,y)](http://python-xy.github.io)
 
 ### On Mac OSX:
 
@@ -109,7 +108,7 @@ For more details on supported platforms, please refer to our
 [installation instructions](http://pythonhosted.org/spyder/installation.html).
 
 **Important note**: This does not install the graphical Python libraries (i.e.
-PyQt5 or PyQt4) that Spyder depend on. Those have to be installed separately
+PyQt5 or PyQt4) that Spyder depends on. Those have to be installed separately
 after installing Python.
 
 

doc/console.rst

@@ -33,29 +33,4 @@ Related plugins:
 * :doc:`help`
 * :doc:`historylog`
 * :doc:`editor`
-* :doc:`explorer`
-
-
-Reloading modules: the User Module Deleter (UMD)
-------------------------------------------------
-
-When working with Python scripts interactively, one must keep in mind that 
-Python import a module from its source code (on disk) only when parsing the
-first corresponding import statement. During this first import, the byte code 
-is generated (.pyc file) if necessary and the imported module code object is 
-cached in `sys.modules`. Then, when re-importing the same module, this cached 
-code object will be directly used even if the source code file (.py[w] file) 
-has changed meanwhile.
-
-This behavior is sometimes unexpected when working with the Python interpreter 
-in interactive mode, because one must either always restart the interpreter 
-or remove manually the .pyc files to be sure that changes made in imported 
-modules were taken into account.
-
-The User Module Deleter (UMD) is a Spyder console's exclusive feature that 
-forces the Python interpreter to reload modules completely when executing 
-a Python script.
-
-For example, when UMD is turned on, one may test complex applications 
-within the same Python interpreter without having to restart it every time 
-(restart time may be relatively long when testing GUI-based applications).
+* :doc:`fileexplorer`

doc/editor.rst

@@ -9,15 +9,27 @@ function/class browser, horizontal/vertical splitting features, etc.
 
 Function/class/method browser:
 
+|
+
 .. image:: images/editor1.png
+   :align: center
+|
 
 Code analysis with `pyflakes`:
 
+|
+
 .. image:: images/editor2.png
+   :align: center
+|
 
 Horizontal/vertical splitting feature:
 
+|
+
 .. image:: images/editor3.png
+   :align: center
+|
 
 How to define a code cell
 --------------------------
@@ -37,5 +49,5 @@ Cells are separated by lines starting with:
 Related plugins:
 
 * :doc:`console`
-* :doc:`explorer`
+* :doc:`fileexplorer`
 * :doc:`findinfiles`

doc/fileexplorer.rst

@@ -0,0 +1,33 @@
+File Explorer
+=============
+
+The file explorer pane is a file/directory browser allowing the user to open
+files with the internal editor or with the appropriate application (Windows
+only).
+
+|
+
+.. image:: images/explorer.png
+   :align: center
+
+|
+
+Context menus may be used to run a script, open a terminal window or run a
+Windows explorer window (Windows only):
+
+|
+
+.. image:: images/explorer_menu1.png
+   :align: center
+
+|
+
+.. image:: images/explorer_menu2.png
+   :align: center
+
+|
+
+Related plugins:
+
+* :doc:`ipythonconsole`
+* :doc:`editor`

doc/index.rst

@@ -30,18 +30,18 @@ Contents:
     overview
     installation
     options
-    console
+    editor
     ipythonconsole
     debugging
+    console
     variableexplorer
     help
-    onlinehelp
+    projects
+    pylint
+    fileexplorer
     historylog
-    explorer
-    projectexplorer
-    editor
     findinfiles
-    pylint
+    onlinehelp
     internalconsole
 
 Indices and tables:

doc/installation.rst

@@ -41,12 +41,12 @@ Updating Spyder
 
 You can update Spyder by:
 
-* Updating Anaconda, WinPython, Python(x,y).
+* Updating Anaconda, WinPython or Python(x,y).
 
 * Or using this command (in case you *don't* use any of those scientific
   distributions)::
 
-        pip install --update spyder
+        pip install --upgrade spyder
 
   .. note::
 
@@ -223,7 +223,7 @@ Installation procedure
 
 2. If you don't use Anaconda, you need to run:
 
-   ``pip install --update spyder``
+   ``pip install --upgrade spyder``
 
 
 Run without installing

doc/internalconsole.rst

@@ -7,41 +7,13 @@ All the commands entered in the internal console are executed in the same
 process as Spyder's, but the Internal Console may be executed in a separate 
 thread (this is optional and for example this is not the case in Spyder itself).
 
+|
+
 .. image:: images/internalconsole.png
+   :align: center
+
+|
 
 The internal console support the following features:
 
 * Code completion and calltips
-* User Module Deleter (as in :doc:`console`)
-
-Special commands
-----------------
-
-The following special commands are supported by the interactive console.
-
-- Edit script
-
-  ``edit foobar.py`` will open ``foobar.py`` with Spyder's editor.
-  ``xedit foobar.py`` will open ``foobar.py`` with the external editor.
-
-- Execute script
-
-  ``run foobar.py`` will execute ``foobar.py`` in interactive console.
-
-- Remove references
-
-  ``clear x, y`` will remove references named ``x`` and ``y``.
-
-- Shell commands
-
-  ``!cmd`` will execute system command ``cmd`` (example ``!ls`` on Linux or
-  ``!dir`` on Windows).
-
-- Python help
-
-  ``object?`` will show ``object``'s help in documentation viewer.
-
-- GUI-based editor
-
-  ``oedit(object)`` will open an appropriate GUI-based editor to modify object
-  ``object`` and will return the result.

doc/ipythonconsole.rst

@@ -7,19 +7,32 @@ a lightweight front-end interface connects to a full IPython kernel on the
 back end. Visit the IPython project website for full documentation of 
 IPython's many features.
 
+|
+
 .. image:: images/ipythonconsole.png
+   :align: center
+|
 
 From the Consoles menu, Spyder can launch **IPython Console**
 instances that attach to kernels that are managed
 by Spyder itself or it can connect to external kernels that are managed
 by IPython Qt Console sessions or the IPython Notebook.
 
+|
+
 .. image:: images/ipythonconsolemenu.png
+   :align: center
+
+|
 
 When "Connect to an existing kernel" is selected, Spyder prompts for the 
 kernel connection file details:
 
+|
+
 .. image:: images/ipythonkernelconnect.png
+   :align: center
+|
 
 **IPython Consoles** that are attached to kernels that were created by
 Spyder support the following features:
@@ -40,9 +53,34 @@ set:
   debugging step commands to the kernel. Breakpoints must be set manually
   from the console command line.
 
+
+Reloading modules: the User Module Reloader (UMR)
+-------------------------------------------------
+
+When working with Python scripts interactively, one must keep in mind that
+Python import a module from its source code (on disk) only when parsing the
+first corresponding import statement. During this first import, the byte code
+is generated (.pyc file) if necessary and the imported module code object is
+cached in `sys.modules`. Then, when re-importing the same module, this cached
+code object will be directly used even if the source code file (.py[w] file)
+has changed meanwhile.
+
+This behavior is sometimes unexpected when working with the Python interpreter
+in interactive mode, because one must either always restart the interpreter
+or remove manually the .pyc files to be sure that changes made in imported
+modules were taken into account.
+
+The User Module Reloader (UMR) is a Spyder console's exclusive feature that
+forces the Python interpreter to reload modules completely when executing
+a Python script.
+
+For example, when UMR is turned on, one may test complex applications
+within the same Python interpreter without having to restart it every time
+(restart time may be relatively long when testing GUI-based applications).
+
+
 Related plugins:
 
 * :doc:`help`
 * :doc:`editor`
-* :doc:`explorer`
-
+* :doc:`fileexplorer`

doc/overview.rst

@@ -47,7 +47,7 @@ Key features:
 
   * *to-do* lists (TODO, FIXME, XXX)
   * errors/warnings (real-time *code analysis* provided by `pyflakes`)
-  * integrated *`pylint` code analysis*
+  * integrated static code analysis (using `pylint`)
   * direct link to `winpdb` external debugger
 
 * :doc:`console`:
@@ -71,8 +71,8 @@ Key features:
 
 * :doc:`onlinehelp`: automatically generated html documentation on installed Python modules
 * :doc:`findinfiles`: find string occurrences in a directory, a mercurial repository or directly in PYTHONPATH (support for regular expressions and  included/excluded string lists)
-* :doc:`explorer`
-* :doc:`projectexplorer` (support Pydev project import)
+* :doc:`fileexplorer`
+* :doc:`projects`
 
 
 Spyder may also be used as a PyQt5 or PyQt4 extension library