diff --git a/docs/xblock-tutorial/getting_started/prereqs.rst b/docs/xblock-tutorial/getting_started/prereqs.rst index 846912899..9a6c8dfd7 100644 --- a/docs/xblock-tutorial/getting_started/prereqs.rst +++ b/docs/xblock-tutorial/getting_started/prereqs.rst @@ -1,8 +1,8 @@ .. _Install XBlock Prerequisites: -################################ +############################ Install XBlock Prerequisites -################################ +############################ To build an XBlock, you must have the following tools on your computer. @@ -11,9 +11,9 @@ To build an XBlock, you must have the following tools on your computer. :depth: 1 -*********** +********** Python 3.8 -*********** +********** To run the a virtual environment and the XBlock SDK, and to build an XBlock, you must have Python 3.8 installed on your computer. @@ -21,11 +21,11 @@ you must have Python 3.8 installed on your computer. `Download Python`_ for your operating system and follow the installation instructions. -**** +*** Git -**** +*** -EdX repositories, including XBlock and the XBlock SDK, are stored on GitHub. +Open edX repositories, including XBlock and the XBlock SDK, are stored on GitHub. To build your own XBlock, and to deploy it later, you must use Git for source control. @@ -33,9 +33,9 @@ control. If you do not have Git installed, or you are are unfamiliar with the tool, see the `GitHub Help`_. -************************ +********************* A Virtual Environment -************************ +********************* It is recommended that you develop your XBlock using a Python virtual environment. A virtual environment is a tool to keep the dependencies required diff --git a/docs/xblock-tutorial/getting_started/setup_sdk.rst b/docs/xblock-tutorial/getting_started/setup_sdk.rst index 510e69692..8d6d2eef7 100644 --- a/docs/xblock-tutorial/getting_started/setup_sdk.rst +++ b/docs/xblock-tutorial/getting_started/setup_sdk.rst @@ -1,8 +1,8 @@ .. _Set Up the XBlock Software Development Kit: -########################################### +########################################## Set Up the XBlock Software Development Kit -########################################### +########################################## Before you continue, make sure that you are familiar with the subjects in the :ref:`Install XBlock Prerequisites` section. @@ -14,9 +14,9 @@ SDK`_ in a virtual environment. To do this, complete the following steps. :local: :depth: 1 -******************************************** +********************************** Create a Directory for XBlock Work -******************************************** +********************************** It is recommended that you create a directory in which to store all your XBlock work, including a virtual environment, the XBlock SDK, and the XBlocks you @@ -38,11 +38,12 @@ develop. .. _Create and Activate the Virtual Environment: -******************************************** +******************************************* Create and Activate the Virtual Environment -******************************************** +******************************************* -You must have a virtual environment tool installed on your computer. For more information, see :ref:`Install XBlock Prerequisites`. +You must have a virtual environment tool installed on your computer. For more +information, see :ref:`Install XBlock Prerequisites`. Then create the virtual environment in your ``xblock_development`` directory. @@ -68,6 +69,8 @@ Then create the virtual environment in your ``xblock_development`` directory. .. include:: ../reusable/clone_sdk.rst -When the requirements are installed, you are in the ``xblock_development`` directory, which contains the ``venv`` and ``xblock-sdk`` subdirectories. You can now :ref:`create your first XBlock `. +When the requirements are installed, you are in the ``xblock_development`` +directory, which contains the ``venv`` and ``xblock-sdk`` subdirectories. You +can now :ref:`create your first XBlock `. .. include:: ../../links.rst