Skip to content

Commit b493e31

Browse files
committed
Update installation guide to include submodules
1 parent 89b23b2 commit b493e31

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

docs/install.rst

+6-7
Original file line numberDiff line numberDiff line change
@@ -30,14 +30,14 @@ In order to get all the dependencies successfully installed,
3030
you need these libraries.
3131

3232
.. tabs::
33-
33+
3434
.. tab:: Mac OS
3535

3636
If you are having trouble on OS X Mavericks
3737
(or possibly other versions of OS X) with building ``lxml``,
3838
you probably might need to use Homebrew_ to ``brew install libxml2``,
3939
and invoke the install with::
40-
40+
4141
CFLAGS=-I/usr/local/opt/libxml2/include/libxml2 \
4242
LDFLAGS=-L/usr/local/opt/libxml2/lib \
4343
pip install -r requirements.txt
@@ -51,7 +51,7 @@ you need these libraries.
5151
sudo apt-get install libxml2-dev libxslt1-dev zlib1g-dev
5252

5353
If you don't have redis installed yet, you can do it with::
54-
54+
5555
sudo apt-get install redis-server
5656

5757
.. tab:: CentOS/RHEL 7
@@ -77,11 +77,10 @@ you need these libraries.
7777
Get and run Read the Docs
7878
-------------------------
7979

80-
Clone the repository somewhere on your disk, enter to the repository, and initialize and update the submodule::
80+
Clone the repository somewhere on your disk, initialize and update the submodule, and enter to the repository::
8181

82-
git clone https://github.com/rtfd/readthedocs.org.git
82+
git clone --recurse-submodules https://github.com/rtfd/readthedocs.org.git
8383
cd readthedocs.org
84-
git submodule update --init
8584

8685
Create a virtual environment and activate it::
8786

@@ -164,7 +163,7 @@ See our :doc:`/intro/import-guide` page to learn more.
164163
Further steps
165164
-------------
166165

167-
By now you can trigger builds on your local environment,
166+
By now you can trigger builds on your local environment,
168167
to encapsulate the build process inside a Docker container,
169168
see :doc:`development/buildenvironments`.
170169

0 commit comments

Comments
 (0)