Skip to content

Commit

Permalink
fixup! af0aa65
Browse files Browse the repository at this point in the history
  • Loading branch information
sarina committed Nov 19, 2023
1 parent af0aa65 commit 59a1940
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 13 deletions.
2 changes: 2 additions & 0 deletions docs/links.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@

.. _VirtualEnvWrapper: http://virtualenvwrapper.readthedocs.io/en/latest

.. _managing different Python versions with virtualenv: https://saturncloud.io/blog/how-to-use-different-python-versions-with-virtualenv/

.. _XBlock SDK: https://github.com/openedx/xblock-sdk

.. _PyEnv: https://github.com/yyuu/pyenv
Expand Down
4 changes: 2 additions & 2 deletions docs/xblock-tutorial/getting_started/create_first_xblock.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. _Create Your First XBlock:

#########################
########################
Create Your First XBlock
#########################
########################

Before you continue, make sure that you have :ref:`set up the XBlock SDK <Set
Up the XBlock Software Development Kit>`. You then create the XBlock and deploy
Expand Down
15 changes: 9 additions & 6 deletions docs/xblock-tutorial/getting_started/setup_sdk.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,9 @@ 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`.
information, see :ref:`Install XBlock Prerequisites`. If you have multiple
Python versions on your machine, see `managing different Python versions with
virtualenv`_.

Then create the virtual environment in your ``xblock_development`` directory.

Expand All @@ -52,25 +54,26 @@ Then create the virtual environment in your ``xblock_development`` directory.

.. code-block:: bash
$ virtualenv venv
$ virtualenv xblock-env
#. Run the following command to activate the virtual environment.

.. code-block:: bash
$ source venv/bin/activate
$ source xblock-env/bin/activate
When the virtual environment is activated, the command prompt shows the name
of the virtual directory in parentheses.

.. code-block:: none
(venv) $
(xblock-env) $
.. 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 <Create Your First XBlock>`.
directory, which contains the ``var``, ``xblock-env``, and ``xblock-sdk``
subdirectories. You can now :ref:`create your first XBlock <Create Your First
XBlock>`.

.. include:: ../../links.rst
10 changes: 5 additions & 5 deletions docs/xblock-tutorial/reusable/clone_sdk.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,29 +14,29 @@ requirements. To do this, complete the following steps at a command prompt.

.. code-block:: bash
(venv) $ git clone https://github.com/openedx/xblock-sdk.git
(xblock-env) $ git clone https://github.com/openedx/xblock-sdk.git
#. In the same directory, create an empty directory called `var`.

.. code-block:: bash
(venv) $ mkdir var
(xblock-env) $ mkdir var
#. Run the following command to change to the ``xblock-sdk`` directory.

.. code-block:: bash
(venv) $ cd xblock-sdk
(xblock-env) $ cd xblock-sdk
#. Run the following commands to install the XBlock SDK requirements.

.. code-block:: bash
(venv) $ make install
(xblock-env) $ make install
#. Run the following command to return to the ``xblock_development`` directory,
where you will perform the rest of your work.

.. code-block:: bash
(venv) $ cd ..
(xblock-env) $ cd ..

0 comments on commit 59a1940

Please sign in to comment.