We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent 43b8a53 commit 4d0795dCopy full SHA for 4d0795d
README.rst
@@ -113,6 +113,29 @@ On Windows:
113
* ``REMOTE_TARANTOOL_CONSOLE_PORT=3302``.
114
* Run ``python setup.py test``.
115
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
128
129
+ $ make docs
130
131
+You may host local documentation server with
132
133
134
135
+ $ python -m http.server --directory build/sphinx/html
136
137
+Open ``localhost:8000`` in your browser to read the docs.
138
139
.. _`Tarantool`:
140
.. _`Tarantool Database`:
141
.. _`Tarantool homepage`: https://tarantool.io
0 commit comments