Make documentation relevant

AUTHORS

@@ -33,3 +33,5 @@ Vladislav Shpilevoy <[email protected]>
 Artem Morozov <[email protected]>
 Sergey Bronnikov <[email protected]>
 Yaroslav Lobankov <[email protected]>
+Georgy Moiseev <[email protected]>
+Oleg Jukovec <[email protected]>

CHANGELOG.md

@@ -15,8 +15,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   type. `tarantool.Datetime` may be encoded to Tarantool datetime
   objects.
 
-  You can create `tarantool.Datetime` objects either from msgpack
-  data or by using the same API as in Tarantool:
+  You can create `tarantool.Datetime` objects either from
+  MessagePack data or by using the same API as in Tarantool:
 
   ```python
   dt1 = tarantool.Datetime(year=2022, month=8, day=31,
@@ -73,8 +73,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   type. `tarantool.Interval` may be encoded to Tarantool interval
   objects.
 
-  You can create `tarantool.Interval` objects either from msgpack
-  data or by using the same API as in Tarantool:
+  You can create `tarantool.Interval` objects either from
+  MessagePack data or by using the same API as in Tarantool:
 
   ```python
   di = tarantool.Interval(year=-1, month=2, day=3,
@@ -138,6 +138,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Bump msgpack requirement to 1.0.4 (PR #223).
   The only reason of this bump is various vulnerability fixes,
   msgpack>=0.4.0 and msgpack-python==0.4.0 are still supported.
+- Change documentation HTML theme (#67).
+- Update API documentation strings (#67).
+- Update documentation index, quick start and guide pages (#67).
 
 ### Fixed
 

INSTALL

@@ -14,4 +14,4 @@ Using `easy_install`::
 
 You can also download the source tarball and install the package using distutils script::
 
-    # python setup.py install
+    # make install

Makefile

@@ -1,4 +1,6 @@
-.PHONY: test
+.PHONY: install test
+install:
+	python setup.py install
 test:
 	python setup.py test
 testdata:

README.rst

@@ -22,31 +22,25 @@ With pip (recommended)
 
 The recommended way to install the ``tarantool`` package is using ``pip``.
 
-For Tarantool version < 1.6.0, get the ``0.3.*`` connector version::
+.. code-block:: bash
 
-    $ pip install tarantool\<0.4
-
-For a later Tarantool version, get the ``0.5.*`` connector version::
-
-    $ pip install tarantool\>0.4
+     $ pip install tarantool
 
 ZIP archive
 ^^^^^^^^^^^
 
-You can also download zip archive, unpack it and run::
+You can also download zip archive, unpack it and run:
 
-    $ python setup.py install
+.. code-block:: bash
+
+    $ make install
 
 Development version
 ^^^^^^^^^^^^^^^^^^^
 
 You can also install the development version of the package using ``pip``.
 
-For Tarantool version < 1.6.0, get the ``stable`` branch::
-
-    $ pip install git+https://github.com/tarantool/tarantool-python.git@stable
-
-For a later Tarantool version, use the ``master`` branch::
+.. code-block:: bash
 
     $ pip install git+https://github.com/tarantool/tarantool-python.git@master
 
@@ -55,17 +49,15 @@ For a later Tarantool version, use the ``master`` branch::
 What is Tarantool?
 ------------------
 
-`Tarantool`_ is an in-memory NoSQL database with a Lua application server on board.
-It combines the network programming power of Node.JS
-with data persistency capabilities of Redis.
-It's open-source, licensed under `BSD-2-Clause`_.
+`Tarantool`_ is an in-memory computing platform originally designed by 
+`VK`_ and released under the terms of `BSD license`_.
 
 Features
 --------
 
 * ANSI SQL, including views, joins, referential and check constraints
 * Lua packages for non-blocking I/O, fibers, and HTTP
-* MsgPack data format and MsgPack-based client-server protocol
+* MessagePack data format and MessagePack-based client-server protocol
 * Two data engines:
 
   * memtx – in-memory storage engine with optional persistence
@@ -97,9 +89,9 @@ Run tests
 
 On Linux:
 
-.. code-block:: console
+.. code-block:: bash
 
-   $ python setup.py test
+   $ make test
 
 On Windows:
 
@@ -111,14 +103,40 @@ On Windows:
 * Set the following environment variables:
   * ``REMOTE_TARANTOOL_HOST=...``,
   * ``REMOTE_TARANTOOL_CONSOLE_PORT=3302``.
-* Run ``python setup.py test``.
+* Run ``make test``.
+
+Build docs
+^^^^^^^^^^
+
+To build documentation, first you must install its build requirements:
+
+.. code-block:: bash
+
+    $ pip install -r requirements-doc.txt
+
+Then run
+
+.. code-block:: bash
+
+    $ make docs
+
+You may host local documentation server with
+
+.. code-block:: bash
+
+    $ python -m http.server --directory build/sphinx/html
+
+Open ``localhost:8000`` in your browser to read the docs.
 
 .. _`Tarantool`:
 .. _`Tarantool Database`:
 .. _`Tarantool homepage`: https://tarantool.io
 .. _`Tarantool on GitHub`: https://github.com/tarantool/tarantool
 .. _`Tarantool documentation`: https://www.tarantool.io/en/doc/latest/
+.. _`VK`: https://vk.company
 .. _`Client-server protocol specification`: https://www.tarantool.io/en/doc/latest/dev_guide/internals/box_protocol/
+.. _`BSD`:
+.. _`BSD license`:
 .. _`BSD-2-Clause`: https://opensource.org/licenses/BSD-2-Clause
 .. _`asynctnt`: https://github.com/igorcoding/asynctnt
 .. _`feature comparison table`: https://www.tarantool.io/en/doc/latest/book/connectors/#python-feature-comparison

doc/_static/favicon/generate-png.sh

@@ -0,0 +1,9 @@
+for SIZE in 16 32 96 128 196
+do
+	convert -background none -resize ${SIZE}x${SIZE} icon.svg icon-${SIZE}x${SIZE}.png
+done
+
+for SIZE in 57 60 72 76 114 120 144 152
+do
+	convert -background none -resize ${SIZE}x${SIZE} icon.svg apple-touch-icon-${SIZE}x${SIZE}.png
+done