Skip to content

Commit

Permalink
docs: update readme for attaching containers
Browse files Browse the repository at this point in the history
  • Loading branch information
Danyal-Faheem committed Nov 13, 2024
1 parent a9ec2e9 commit 5848679
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions docs/tutorials/edx-platform.rst
Original file line number Diff line number Diff line change
Expand Up @@ -128,16 +128,18 @@ After you implement and enable that plugin, ``tutor mounts list`` should display
Debugging with breakpoints
--------------------------

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::
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 ``attach`` followed by the service's name::

# Start in detached mode:
tutor dev start -d

# Debugging LMS:
tutor dev start lms
tutor dev attach lms

# Or, debugging CMS:
tutor dev start cms
tutor dev attach cms

To detach from the container without shutting it down, use ``Ctrl+p`` followed with ``Ctrl+q``.

Running edx-platform unit tests
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down

0 comments on commit 5848679

Please sign in to comment.