python273 · python273 · Apr 14, 2018 · Mar 31, 2018 · Apr 1, 2018 · Apr 2, 2018
diff --git a/docs/_static/css/custom.css b/docs/_static/css/custom.css
@@ -0,0 +1,3 @@
+.logo {
+    font-family: "Courier New", Courier, "Liberation Mono", "Anonymous Pro", monospace;
+}
diff --git a/docs/_static/custom.css b/docs/_static/custom.css
diff --git a/docs/_templates/sidebarlogo.html b/docs/_templates/sidebarlogo.html
diff --git a/docs/audio.rst b/docs/audio.rst
@@ -0,0 +1,8 @@
+VkAudio
+=======
+
+Модуль для работы с аудио
+
+.. module:: vk_api.audio
+.. autoclass:: VkAudio
+    :members:
diff --git a/docs/conf.py b/docs/conf.py
@@ -68,7 +68,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = 'en'
+language = 'ru'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -85,6 +85,7 @@
 # a list of builtin themes.
 #
 html_theme = 'alabaster'
+# html_theme = "sphinx_rtd_theme"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
@@ -95,6 +96,7 @@
     'github_user': 'python273',
     'github_repo': 'vk_api',
     'github_banner': True,
+    'github_type': 'star',
     'show_related': False
 }
 
@@ -111,10 +113,19 @@
 # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
 # 'searchbox.html']``.
 #
+# html_sidebars = {
+#     '**': [
+#         'sidebarlogo.html', 'localtoc.html', 'relations.html',
+#         'sourcelink.html', 'searchbox.html'
+#     ]
+# }
 html_sidebars = {
     '**': [
-        'sidebarlogo.html', 'localtoc.html', 'relations.html',
-        'sourcelink.html', 'searchbox.html'
+        'about.html',
+        'navigation.html',
+        'relations.html',
+        'searchbox.html',
+        'donate.html',
     ]
 }
 
@@ -178,6 +189,11 @@
 
 # -- Extension configuration -------------------------------------------------
 
+# -- Options for autodoc extension -------------------------------------------
+
+autodoc_inherit_docstrings = False
+autodoc_member_order = 'bysource'
+
 # -- Options for todo extension ----------------------------------------------
 
 # If true, `todo` and `todoList` produce output, else they produce nothing.

diff --git a/docs/exceptions.rst b/docs/exceptions.rst
@@ -0,0 +1,7 @@
+Исключения библиотеки
+=====================
+
+.. automodule:: vk_api.exceptions
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/execute.rst b/docs/execute.rst
@@ -0,0 +1,9 @@
+VkFunction
+==========
+
+Модуль для работы с методом execute
+
+.. module:: vk_api.execute
+.. autoclass:: VkFunction
+    :members:
+    :special-members: __call__
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,14 +1,36 @@
-Welcome to vk_api's documentation!
-==================================
+Документация vk_api
+===================
 
 vk_api – Python модуль для написания скриптов для социальной сети Вконтакте
 (vk.com) (API wrapper)
 
+`Установка через PIP
+<https://pythonworld.ru/osnovy/pip.html>`_:
+
+.. code-block:: shell-session
+
+   $ pip install --user vk_api
+
+или
+
+.. code-block:: shell-session
+
+   # pip install vk_api
+
+Примеры по использованию библиотеки доступны на `GitHub <https://github.com/python273/vk_api/tree/master/examples>`_.
+
 .. toctree::
    :maxdepth: 4
-   :caption: Contents:
+   :caption: Содержание:
 
    vk_api
+   audio
+   longpoll
+   execute
+   requests_pool
+   tools
+   upload
+   exceptions
    jconfig
 
 

diff --git a/docs/jconfig.rst b/docs/jconfig.rst
@@ -1,38 +1,22 @@
-jconfig package
-===============
+Пакет jconfig
+=============
 
-Submodules
-----------
+BaseConfig
+---------------------------
 
-jconfig.base module
--------------------
-
-.. automodule:: jconfig.base
+.. autoclass:: jconfig.base.BaseConfig
     :members:
-    :undoc-members:
-    :show-inheritance:
 
-jconfig.jconfig module
-----------------------
+Config (хранение в json файле)
+------------------------------
 
-.. automodule:: jconfig.jconfig
+.. autoclass:: jconfig.jconfig.Config
     :members:
-    :undoc-members:
     :show-inheritance:
 
-jconfig.memory module
----------------------
-
-.. automodule:: jconfig.memory
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-
-Module contents
----------------
+MemoryConfig (хранение в памяти)
+--------------------------------
 
-.. automodule:: jconfig
+.. autoclass:: jconfig.memory.MemoryConfig
     :members:
-    :undoc-members:
     :show-inheritance:
diff --git a/docs/longpoll.rst b/docs/longpoll.rst
@@ -0,0 +1,22 @@
+Модуль `longpoll` (VkLongPoll)
+==============================
+
+Модуль для работы с longpoll
+
+.. module:: vk_api.longpoll
+.. autoclass:: VkLongPoll
+    :members:
+.. autoclass:: Event
+    :members:
+.. autoclass:: VkLongpollMode
+    :members:
+.. autoclass:: VkEventType
+    :members:
+.. autoclass:: VkPlatform
+    :members:
+.. autoclass:: VkOfflineType
+    :members:
+.. autoclass:: VkMessageFlag
+    :members:
+.. autoclass:: VkPeerFlag
+    :members:
diff --git a/docs/requests_pool.rst b/docs/requests_pool.rst
@@ -0,0 +1,10 @@
+VkRequestsPool
+==============
+
+Модуль для объединения запросов в один запрос execute
+
+.. module:: vk_api.requests_pool
+.. autoclass:: VkRequestsPool
+    :members:
+.. autoclass:: RequestResult
+    :members:
diff --git a/docs/tools.rst b/docs/tools.rst
@@ -0,0 +1,8 @@
+VkTools
+=======
+
+Модуль для выкачивания множества результатов
+
+.. module:: vk_api.tools
+.. autoclass:: VkTools
+    :members:
diff --git a/docs/upload.rst b/docs/upload.rst
@@ -0,0 +1,8 @@
+VkUpload
+========
+
+Модуль для загрузки медиафайлов в VK
+
+.. module:: vk_api.upload
+.. autoclass:: VkUpload
+    :members:
diff --git a/docs/vk_api.rst b/docs/vk_api.rst
@@ -1,102 +1,11 @@
-vk\_api package
-===============
+VkApi (основной класс)
+======================
 
-Submodules
-----------
+.. module:: vk_api.vk_api
 
-vk\_api.audio module
---------------------
-
-.. automodule:: vk_api.audio
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-vk\_api.audio\_url\_decoder module
-----------------------------------
-
-.. automodule:: vk_api.audio_url_decoder
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-vk\_api.enums module
---------------------
-
-.. automodule:: vk_api.enums
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-vk\_api.exceptions module
--------------------------
-
-.. automodule:: vk_api.exceptions
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-vk\_api.execute module
-----------------------
-
-.. automodule:: vk_api.execute
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-vk\_api.longpoll module
------------------------
-
-.. automodule:: vk_api.longpoll
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-vk\_api.requests\_pool module
------------------------------
-
-.. automodule:: vk_api.requests_pool
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-vk\_api.tools module
---------------------
-
-.. automodule:: vk_api.tools
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-vk\_api.upload module
----------------------
-
-.. automodule:: vk_api.upload
+.. autoclass:: VkApi
     :members:
-    :undoc-members:
-    :show-inheritance:
-
-vk\_api.utils module
---------------------
 
-.. automodule:: vk_api.utils
-    :members:
-    :undoc-members:
+.. autoclass:: VkUserPermissions
     :show-inheritance:
-
-vk\_api.vk\_api module
-----------------------
-
-.. automodule:: vk_api.vk_api
     :members:
-    :undoc-members:
-    :show-inheritance:
-
-
-Module contents
----------------
-
-.. automodule:: vk_api
-    :members:
-    :undoc-members:
-    :show-inheritance:
diff --git a/jconfig/__init__.py b/jconfig/__init__.py
@@ -1,10 +1,10 @@
 # -*- coding: utf-8 -*-
 """
-@author: python273
-@contact: https://vk.com/python273
-@license Apache License, Version 2.0, see LICENSE file
+:authors: python273
+:contact: https://vk.com/python273
+:license: Apache License, Version 2.0, see LICENSE file
 
-Copyright (C) 2018
+:copyright: (c) 2018 python273
 """
 
 __author__ = 'python273'