Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[doc] Add debugging information to play scripts in SSH #1019

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion doc/teacher_doc/testing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,16 @@ Every administrator is able from the frontend to launch a debugging job. This is
on the *>_* (left-chevron, underscore) button next to the *Submit* button. According to your
configuration, either a SSH command-line with auto-generated password will be given you (you will,
in this case, need an SSH client installed), or an embedded SSH console will pop up as the
feedback position.
feedback position.

Debugging IPython scripts (run.py)
``````````````````````````````````
As mentioned in :ref:`run_file`, INGInious uses IPython and is configured to expose a few
functions such as ``get_input`` or ``set_feedback``. Therefore, you can't directly use the ``python``
interpreter but must use `inginious-ipython`, for instance ``inginious-ipython run.py``.

Debugging bash scripts (run.sh)
````````````````````````````````
As opposed to python scripts, INGInious functions are exposed through the
environment so there is no need to use a particular loader. ``source run.sh`` might be a better
choice than running the script in a subshell to observe the state of variables after execution.
Loading