christianlight
/
tutor
mirror of https://github.com/ChristianLight/tutor.git
7
0
Fork 0
Code Issues Releases Activity

docs: add more clarity to debugging section

This commit is contained in:
Emad Rad 2023-11-29 11:23:29 +03:30 committed by Régis Behmo
parent d3aa7d9a52
commit 0ef86fc2a0
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/dev.rst
View File

@ -86,7 +86,10 @@ Finally, the platform can also be started back up with ``launch``. It will take
Debugging with breakpoints
--------------------------
To debug a local edx-platform repository, add a `python breakpoint <https://docs.python.org/3/library/functions.html#breakpoint>`__ with ``breakpoint()`` anywhere in the code. Then, attach to the applicable service's container by running ``start`` (without ``-d``) followed by the service's name::
To debug a local edx-platform repository, first, start development in detached mode (with ``-d``), add a `python breakpoint <https://docs.python.org/3/library/functions.html#breakpoint>`__ with ``breakpoint()`` anywhere in the code. Then, attach to the applicable service's container by running ``start`` (without ``-d``) followed by the service's name::
# Start in detached mode:
tutor dev start -d
# Debugging LMS:
tutor dev start lms