Minor clean-up.

README.rst

@@ -226,9 +226,7 @@ E-Commerce Service, you would modify ``ECOMMERCE_VERSION`` in
 PyCharm Integration
 -------------------
 
-
-`Pycharm Config`_
-
+See the `Pycharm Integration documentation`_.
 
 Troubleshooting: General Tips
 -----------------------------
@@ -279,22 +277,9 @@ Start over
 If you want to completely start over, run ``make destroy``. This will remove
 all containers, networks, AND data volumes.
 
-
-.. _Docker Compose: https://docs.docker.com/compose/
-.. _Docker for Mac: https://docs.docker.com/docker-for-mac/
-.. _Docker for Windows: https://docs.docker.com/docker-for-windows/
-.. _Docker Sync: https://github.com/EugenMayer/docker-sync/wiki
-.. _Docker Sync installation instructions: https://github.com/EugenMayer/docker-sync/wiki/1.-Installation
-.. _configuring Docker for Mac: https://docs.docker.com/docker-for-mac/#/advanced
-.. _Pycharm Config: docs/pycharm_config.rst
-.. |Build Status| image:: https://travis-ci.org/edx/devstack.svg?branch=master
-   :target: https://travis-ci.org/edx/devstack
-
-
 Troubleshooting: Common issues
 ------------------------------
 
-
 File ownership change
 ~~~~~~~~~~~~~~~~~~~~~
 
@@ -356,3 +341,13 @@ Or, you can run the following commands to clean up dangling images and volumes:
 
    docker rmi $(docker images -f "dangling=true" -q)
    docker volume rm $(docker volume ls -qf dangling=true)
+
+.. _Docker Compose: https://docs.docker.com/compose/
+.. _Docker for Mac: https://docs.docker.com/docker-for-mac/
+.. _Docker for Windows: https://docs.docker.com/docker-for-windows/
+.. _Docker Sync: https://github.com/EugenMayer/docker-sync/wiki
+.. _Docker Sync installation instructions: https://github.com/EugenMayer/docker-sync/wiki/1.-Installation
+.. _configuring Docker for Mac: https://docs.docker.com/docker-for-mac/#/advanced
+.. _Pycharm Integration documentation: docs/pycharm_integration.rst
+.. |Build Status| image:: https://travis-ci.org/edx/devstack.svg?branch=master
+   :target: https://travis-ci.org/edx/devstack

docs/pycharm_config.rst → docs/pycharm_integration.rst

@@ -37,35 +37,36 @@ use the following options:
 
   - Docker Sync (Mac)
 
-    -  ``/LOCAL/PATH/TO/devstack/docker-compose.yml (e.g.~/edx/devstack/docker-compose.yml)``
-    -  ``/LOCAL/PATH/TO/devstack/docker-compose-sync.yml``
+    - ``/LOCAL/PATH/TO/devstack/docker-compose.yml`` (e.g.~/edx/devstack/docker-compose.yml)
+    - ``/LOCAL/PATH/TO/devstack/docker-compose-sync.yml``
 
   - Without Docker Sync
 
-    -  ``/LOCAL/PATH/TO/devstack/docker-compose.yml (e.g.~/edx/devstack/docker-compose.yml)``
-    -  ``/LOCAL/PATH/TO/devstack/docker-compose-host.yml``
+    - ``/LOCAL/PATH/TO/devstack/docker-compose.yml`` (e.g.~/edx/devstack/docker-compose.yml)
+    - ``/LOCAL/PATH/TO/devstack/docker-compose-host.yml``
 
--  Service: lms (or whatever IDE you wish to test)
+- Service: lms (or whatever IDE you wish to test)
 
--  Environment variables:
+- Environment variables:
 
-  -  ``DEVSTACK_WORKSPACE=/LOCAL/PARENT/PATH/TO(/devstack) (e.g. ~/edx)``
+  - ``DEVSTACK_WORKSPACE=/LOCAL/PARENT/PATH/TO/devstack`` (e.g. ~/edx - without
+    "devstack")
 
--  Python interpreter path:
+- Python interpreter path:
 
-  -  The remote path should be set to the service's virtual environment:
+  - The remote path should be set to the service's virtual environment:
 
-    -  ``/edx/app/<SERVICE_NAME>/venvs/<SERVICE_NAME>/bin/python``
+    - ``/edx/app/<SERVICE_NAME>/venvs/<SERVICE_NAME>/bin/python``
 
-  -  For example, the path would be the following for the Credentials Service:
+  - For example, the path would be the following for the Credentials Service:
 
-    -  ``/edx/app/credentials/venvs/credentials/bin/python``
+    - ``/edx/app/credentials/venvs/credentials/bin/python``
 
-  -  For either lms or studio, you need to use edxapp:
+  - For either lms or studio, you need to use edxapp:
 
-    -  ``/edx/app/edxapp/venvs/edxapp/bin/python``
+    - ``/edx/app/edxapp/venvs/edxapp/bin/python``
 
--  PyCharm helpers path: Keep the default.
+- PyCharm helpers path: Keep the default.
 
 
 **Important** If you are running with Docker Sync you will also need to first
@@ -74,22 +75,19 @@ run ``docker-sync start`` to run sync in the background before running any serve
 
 **Note**: For lms and studio (edx-platform), it will take a long time to
 update skeletons (10 or more minutes). If you want to try a different
-set of configuration (compose) files, I recommend you create a new one
+set of configuration (compose) files, we recommend you create a new one
 so you can easily switch back to old without this delay.
 
 
-**Warning**: When you change configuration files, the
-service dropdown gets reset. Remember to restore to the IDA you wish to
-test.
+**Warning**: When you change configuration files, the service dropdown gets
+reset. Remember to restore to the IDA you wish to test.
 
 Setup a Server Run/Debug Configuration
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 After configuring the interpreter, you should setup a `Django Server
-Run/Debug
-Configuration <https://www.jetbrains.com/help/pycharm/2017.1/run-debug-configuration-django-server.html>`__.
-Note that there are some specific values that should be used for this
-configuration.
+Run/Debug Configuration`_. Note that there are some specific values that should
+be used for this configuration.
 
 The host should always be set to ``0.0.0.0`` so that Django accepts
 requests from external clients (e.g. your Docker host). The port should
@@ -108,22 +106,27 @@ Add a new Run/Debug Configuration of type "Django server", with the
 following options:
 
 1. Leave host/port blank
+
 2. Additional options: runserver 0.0.0.0:18000 (or runserver
    0.0.0.0:18010)
+
 3. Custom run command: lms (or cms)
+
 4. Environment variables, add the following for lms/studio:
 
-   -  ``DJANGO\_SETTINGS\_MODULE=lms.envs.devstack\_docker (or
-      cms.envs.devstack\_docker)``
-   -  ``PYTHONUNBUFFERED=1``
+   - ``DJANGO_SETTINGS_MODULE=lms.envs.devstack_docker`` (or
+     cms.envs.devstack_docker)
+   - ``PYTHONUNBUFFERED=1``
 
 5. Python Interpreter: Choose the Docker Compose interpreter for this
    service.
+
 6. Working directory: /edx/app/edxapp/edx-platform
+
 7. Path mappings (add mapping):
 
-   -  Local path: /LOCAL/PATH/TO/edx-platform (e.g. ~/edx/edx-platform)
-   -  Remote path: /edx/app/edxapp/edx-platform
+   - Local path: /LOCAL/PATH/TO/edx-platform (e.g. ~/edx/edx-platform)
+   - Remote path: /edx/app/edxapp/edx-platform
 
 8. Deselect "Add content..." and "Add source..."
 
@@ -133,32 +136,34 @@ Setup a Django tests Run/Debug Configuration for LMS or Studio
 To run and debug unit tests, create a "Django tests" type Run/Dubug
 configuration with the following options:
 
-1. Target: lms.djangoapps.grades.tests.test\_grades:TestGradeIteration
+1. Target: lms.djangoapps.grades.tests.test_grades:TestGradeIteration
+
 2. Environment Variables:
 
--  DJANGO\_SETTINGS\_MODULE=lms.envs.test\_docker
--  DISABLE\_MIGRATIONS=1
--  PYTHONUNBUFFERED=1
+    - DJANGO_SETTINGS_MODULE=lms.envs.test_docker
+    - DISABLE_MIGRATIONS=1
+    - PYTHONUNBUFFERED=1
 
 3. Working directory: /edx/app/edxapp/edx-platform
+
 4. Path mappings (add mapping):
 
-   -  Local path: LOCAL/PATH/TO/edx-platform (e.g. ~/edx/edx-platform)
-   -  Remote path: /edx/app/edxapp/edx-platform
+   - Local path: LOCAL/PATH/TO/edx-platform (e.g. ~/edx/edx-platform)
+   - Remote path: /edx/app/edxapp/edx-platform
 
 5. Deselect "Add content..." and "Add source..."
 
 **Tip**: You can adjust the default configuration if you will be
 replicating this.
 
-
 Currently not supported for PyCharm Development
-~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-
--  PyCharm debugging with BokChoy and JavaScript
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
+- Debugging for BokChoy
+- Debugging for JavaScript
+- Cython for fasterdebug
 
 .. _PyCharm: https://www.jetbrains.com/pycharm/
 .. _PyCharm IDE setup: https://openedx.atlassian.net/wiki/display/ENG/PyCharm
 .. _vendor documentation: https://www.jetbrains.com/help/pycharm/2017.1/configuring-remote-interpreters-via-docker-compose.html
+.. _Django Server Run/Debug Configuration: https://www.jetbrains.com/help/pycharm/2017.1/run-debug-configuration-django-server.html