Skip to content

Commit

Permalink
Merge pull request #3174 from sylvain-bougnoux/master
Browse files Browse the repository at this point in the history
PR: Fix tutorial images on Windows
  • Loading branch information
ccordoba12 authored Jun 11, 2016
2 parents e4959e5 + 8aa5101 commit ebb7ca7
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 9 deletions.
3 changes: 1 addition & 2 deletions spyderlib/plugins/help.py
Original file line number Diff line number Diff line change
Expand Up @@ -747,10 +747,9 @@ def show_plain_text(self, text):
@Slot()
def show_tutorial(self):
tutorial_path = get_module_source_path('spyderlib.utils.help')
img_path = osp.join(tutorial_path, 'static', 'images')
tutorial = osp.join(tutorial_path, 'tutorial.rst')
text = open(tutorial).read()
self.show_rich_text(text, collapse=True, img_path=img_path)
self.show_rich_text(text, collapse=True)

def handle_link_clicks(self, url):
url = to_text_string(url.toString())
Expand Down
14 changes: 7 additions & 7 deletions spyderlib/utils/help/tutorial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,7 @@ Inspecting objects defined in the console
the same information as we obtained from ``help(hello)`` is provided
automatically in the Help:

.. image:: static/images/spyder-hello-docstring.png
.. image:: images/spyder-hello-docstring.png
:align: center

This works in the console and in the editor.
Expand Down Expand Up @@ -415,7 +415,7 @@ reports what it has done.
We can then use the variables ``x``, ``y``, for example like this:

.. image:: static/images/spyder-sympy-example.png
.. image:: images/spyder-sympy-example.png
:align: center


Expand Down Expand Up @@ -711,7 +711,7 @@ in Spyder.
For example, to get an ``average()`` function look like this in the
Spyder Help pane:

.. image:: static/images/spyder-nice-docstring-rendering.png
.. image:: images/spyder-nice-docstring-rendering.png
:align: center

you need to format the documentation string as follows
Expand Down Expand Up @@ -772,19 +772,19 @@ i.e. not function or class objects)
After entering debug mode, you can execute the code line by line using the
``Step`` button of the Debug toolbar:

.. image:: static/images/debug-step-over.png
.. image:: images/debug-step-over.png
:align: center

or the shortcut Ctrl+F10. You can also inspect how a particular function is
working by stepping into it with the ``Step into`` button

.. image:: static/images/debug-step-in.png
.. image:: images/debug-step-in.png
:align: center

or the shortcut Ctrl+F11. Finally, to get out of a function and continue with
the next line you need to use the ``Step return`` button

.. image:: static/images/debug-step-out.png
.. image:: images/debug-step-out.png
:align: center

or the shortcut Ctrl+F12.
Expand All @@ -794,7 +794,7 @@ If you prefer to inspect your program at a specific point, you need to insert a
that a red dot will be placed next to the line and you can press the ``Continue``
button

.. image:: static/images/debug-continue.png
.. image:: images/debug-continue.png
:align: center

(after entering debug mode) to stop the execution at that line.
Expand Down

0 comments on commit ebb7ca7

Please sign in to comment.