Skip to content

Commit 4d0795d

Browse files
readme: add documentation build guide
Part of #67
1 parent 43b8a53 commit 4d0795d

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.rst

+23
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,29 @@ On Windows:
113113
* ``REMOTE_TARANTOOL_CONSOLE_PORT=3302``.
114114
* Run ``python setup.py test``.
115115

116+
Build docs
117+
^^^^^^^^^^
118+
119+
To build documentation, first you must install its build requirements:
120+
121+
.. code-block:: bash
122+
123+
$ pip install -r requirements-doc.txt
124+
125+
Then run
126+
127+
.. code-block:: bash
128+
129+
$ make docs
130+
131+
You may host local documentation server with
132+
133+
.. code-block:: bash
134+
135+
$ python -m http.server --directory build/sphinx/html
136+
137+
Open ``localhost:8000`` in your browser to read the docs.
138+
116139
.. _`Tarantool`:
117140
.. _`Tarantool Database`:
118141
.. _`Tarantool homepage`: https://tarantool.io

0 commit comments

Comments
 (0)