From 3fa2565fd7d735b7ea9cfd6128cee7b604a8bb81 Mon Sep 17 00:00:00 2001
From: condor-the-bird <kondor40@ya.ru>
Date: Fri, 2 Oct 2015 15:13:41 +0400
Subject: [PATCH] Update building_documentation.rst
---
doc/sphinx/dev_guide/building_documentation.rst | 15 +++++++++------
1 file changed, 9 insertions(+), 6 deletions(-)
diff --git a/doc/sphinx/dev_guide/building_documentation.rst b/doc/sphinx/dev_guide/building_documentation.rst
index d1f8d0545b..038ffe28c7 100644
--- a/doc/sphinx/dev_guide/building_documentation.rst
+++ b/doc/sphinx/dev_guide/building_documentation.rst
@@ -6,16 +6,19 @@
After building and testing your local instance of Tarantool, you can build a local version of this documentation to contribute to it.
-Documentation is based on python-based Sphinx generator. So, make sure to install all python modules indicated in the **Building from Source** section of this documentation. The procedure below implies that you already took those steps and successfully tested your instance of Tarantool.
- 1. Build the documentation package.
-Run the following set of commands (the example below shows the set for Ubunto OS, but the precedure is similar for other supported OS's):
+Documentation is based on python-based Sphinx generator. So, make sure to install all python modules indicated in the BUILDING FROM SOURCE (http://tarantool.org/doc/dev_guide/building_from_source.html) section of this documentation. The procedure below implies that you already took those steps and successfully tested your instance of Tarantool.
+ 1. Build a local version of the existing documentation package.
+
+Run the following set of commands (the example below shows the set for Ubuntu OS, but the precedure is similar for other supported OS's):
+
.. code-block:: bash
cd ~/tarantool
cmake -DENABLE_DOC=TRUE
make -C doc
-Documentation is created and stored at ``doc/www/output``.
+Documentation is created and stored at DOC/WWW/OUTPUT.
+
2. Set up a web-server.
Note that if your Tarantool Database runs on a Virtual machine, you need to make sure that your host and client machines operate in the same network, i.e. to configure port forwarding. If you use Oracle VM VirtualBox, follow the guidelines below:
@@ -26,7 +29,7 @@ Note that if your Tarantool Database runs on a Virtual machine, you need to make
* Set Host and Guest Ports to ``8000``, Host IP to ``127.0.0.1`` and Guest IP to ``10.0.2.15``. Make sure to check the IP of your VB instance, it must be 10.0.2.15 (``ifconfig`` command)
* Save your settings
-On Ubuntu run the following command to set up a web-server. Make sure to run it from the documentation output folder, as specified below:
+Run the following command to set up a web-server (the example below is based on Ubuntu, but the procedure is similar for other supported OS's). Make sure to run it from the documentation output folder, as specified below:
.. code-block:: bash
@@ -35,7 +38,7 @@ On Ubuntu run the following command to set up a web-server. Make sure to run it
3. Open your browser and enter ``127.0.0.1:8000`` into the address box. If your local documentation build is valid, the HTML version will be displayed in the browser.
-To contribute to documentation, use the ``.rst`` format for drafting and submit your updates as **Pull Requests** via GitHub.
+To contribute to documentation, use the ``.rst`` format for drafting and submit your updates as "Pull Requests" via GitHub.
To comply with the writing and formatting style, use guidelines provided in the documentation, common sense and existing documents.
--
GitLab