Fix docs

Author: python273

docs/bots_longpoll.rst

@@ -6,5 +6,8 @@
 .. module:: vk_api.bot_longpoll
 .. autoclass:: VkBotLongPoll
     :members:
-.. autoclass:: BotEvent
+.. autoclass:: VkBotEvent
+    :members:
+.. autoclass:: VkBotMessageEvent
+    :show-inheritance:
     :members:

docs/enums.rst

@@ -0,0 +1,6 @@
+Enums
+=====
+
+.. autoclass:: vk_api.enums.VkUserPermissions
+    :members:
+    :show-inheritance:

docs/exceptions.rst

@@ -1,5 +1,5 @@
-Исключения библиотеки
-=====================
+Исключения
+==========
 
 .. automodule:: vk_api.exceptions
     :members:

docs/index.rst

@@ -19,19 +19,32 @@ vk_api – Python модуль для написания скриптов для
 
 Примеры по использованию библиотеки доступны на `GitHub <https://github.com/python273/vk_api/tree/master/examples>`_.
 
+.. code-block:: python
+
+   import vk_api
+
+   vk_session = vk_api.VkApi('+71234567890', 'mypassword')
+   vk_session.auth()
+
+   vk = vk_session.get_api()
+
+   print(vk.wall.post(message='Hello world!'))
+
+
 .. toctree::
    :maxdepth: 4
    :caption: Содержание:
 
    vk_api
-   audio
+   upload
+   tools
    longpoll
    bots_longpoll
-   execute
-   requests_pool
-   tools
-   upload
    keyboard
+   audio
+   requests_pool
+   execute
+   enums
    exceptions
    jconfig
 

docs/keyboard.rst

@@ -1,5 +1,5 @@
 VkKeyboard
-=======
+==========
 
 Модуль для удобного создания клавиатур для ботов
 

docs/requests_pool.rst

@@ -8,3 +8,4 @@ VkRequestsPool
     :members:
 .. autoclass:: RequestResult
     :members:
+.. autofunction:: vk_request_one_param_pool

jconfig/base.py

@@ -13,7 +13,7 @@ class BaseConfig(object):
     У наследуемых классов должен быть определен `__slots__`
 
     :param section: имя подкатегории в конфиге
-    :param \\**kwargs: будут переданы в :func:`load`
+    :param \*\*kwargs: будут переданы в :func:`load`
     """
 
     __slots__ = ('section_name', '_settings', '_section')

vk_api/bot_longpoll.py

@@ -1,6 +1,7 @@
-import requests
 from enum import Enum
 
+import requests
+
 CHAT_START_ID = int(2E9)
 
 
@@ -80,7 +81,19 @@ class VkBotEventType(Enum):
 class VkBotEvent(object):
     """ Событие Bots Long Poll
 
-    Имеет поля в соответствии с `документацией <https://vk.com/dev/groups_events>`_.
+    :ivar raw: событие, в каком виде было получено от сервера
+
+    :ivar type: тип события
+    :vartype type: VkBotEventType or str
+
+    :ivar t: сокращение для type
+    :vartype t: VkBotEventType or str
+
+    :ivar object: объект события, в каком виде был получен от сервера
+    :ivar obj: сокращение для object
+
+    :ivar group_id: ID группы бота
+    :vartype group_id: int
     """
 
     __slots__ = (
@@ -106,10 +119,24 @@ def __init__(self, raw):
         self.group_id = raw['group_id']
 
     def __repr__(self):
-        return f'<{type(self)}({self.raw})>'
+        return '<{}({})>'.format(type(self), self.raw)
+
 
 class VkBotMessageEvent(VkBotEvent):
-    """ Событие с сообщением Bots Long Poll """
+    """ Событие с сообщением Bots Long Poll
+
+    :ivar from_user: сообщение от пользователя
+    :vartype from_user: bool
+
+    :ivar from_chat: сообщение из беседы
+    :vartype from_chat: bool
+
+    :ivar from_group: сообщение от группы
+    :vartype from_group: bool
+
+    :ivar chat_id: ID чата
+    :vartype chat_id: int
+    """
 
     __slots__ = ('from_user', 'from_chat', 'from_group', 'chat_id')
 
@@ -146,11 +173,14 @@ class VkBotLongPoll(object):
         'key', 'server', 'ts'
     )
 
+    #: Классы для событий по типам
     CLASS_BY_EVENT_TYPE = {
         VkBotEventType.MESSAGE_NEW.value: VkBotMessageEvent,
         VkBotEventType.MESSAGE_REPLY.value: VkBotMessageEvent,
         VkBotEventType.MESSAGE_EDIT.value: VkBotMessageEvent,
     }
+
+    #: Класс для событий
     DEFAULT_EVENT_CLASS = VkBotEvent
 
     def __init__(self, vk, group_id, wait=25):
@@ -189,8 +219,7 @@ def update_longpoll_server(self, update_ts=True):
             self.ts = response['ts']
 
     def check(self):
-        """
-        Получить события от сервера один раз
+        """ Получить события от сервера один раз
 
         :returns: `list` of :class:`Event`
         """
@@ -227,8 +256,7 @@ def check(self):
         return []
 
     def listen(self):
-        """
-        Слушать сервер
+        """ Слушать сервер
 
         :yields: :class:`Event`
         """

vk_api/enums.py

@@ -16,52 +16,67 @@ class VkUserPermissions(IntEnum):
     Список прав получается побитовым сложением (x & y) каждого права.
     Подробнее в документации VK API: https://vk.com/dev/permissions
     """
+
+    #: Пользователь разрешил отправлять ему уведомления
+    #: (для flash/iframe-приложений).
+    #: Не работает с этой библиотекой.
     NOTIFY = 1
-    """
-    Пользователь разрешил отправлять ему уведомления (для flash/iframe-приложений).
-    Это право бесполезно для этой библиотеки.
-    """
+
+    #: Доступ к друзьям.
     FRIEND = 2
-    """Доступ к друзьям."""
+
+    #: Доступ к фотографиям.
     PHOTOS = 2**2
-    """Доступ к фотографиям."""
+
+    #: Доступ к аудиозаписям.
+    #: При отсутствии доступа к закрытому API аудиозаписей это право позволяет
+    #: только загрузку аудио.
     AUDIO = 2**3
-    """
-    Доступ к аудиозаписям.
-    При отсутствии доступа к закрытому API аудиозаписей это право позволяет только загрузку аудио.
-    """
+
+    #: Доступ к видеозаписям.
     VIDEO = 2**4
-    """Доступ к видеозаписям."""
+
+    #: Доступ к историям.
     STORIES = 2**6
-    """Доступ к историям."""
+
+    #: Доступ к wiki-страницам.
     PAGES = 2**7
-    """Доступ к wiki-страницам."""
+
+    #: Добавление ссылки на приложение в меню слева.
     ADD_LINK = 2**8
-    """Добавление ссылки на приложение в меню слева."""
+
+    #: Доступ к статусу пользователя.
     STATUS = 2**10
-    """Доступ к статусу пользователя."""
+
+    #: Доступ к заметкам пользователя.
     NOTES = 2**11
-    """Доступ к заметкам пользователя."""
+
+    #: Доступ к расширенным методам работы с сообщениями.
     MESSAGES = 2**12
-    """Доступ к расширенным методам работы с сообщениями."""
+
+    #: Доступ к обычным и расширенным методам работы со стеной.
     WALL = 2**13
-    """Доступ к обычным и расширенным методам работы со стеной."""
+
+    #: Доступ к расширенным методам работы с рекламным API.
     ADS = 2**15
-    """Доступ к расширенным методам работы с рекламным API."""
+
+    #: Доступ к API в любое время. Рекомендуется при работе с этой библиотекой.
     OFFLINE = 2**16
-    """
-    Доступ к API в любое время.
-    Рекомендуется при работе с этой библиотекой.
-    """
+
+    #: Доступ к документам.
     DOCS = 2**17
-    """Доступ к документам."""
+
+    #: Доступ к группам пользователя.
     GROUPS = 2**18
-    """Доступ к группам пользователя."""
+
+    #: Доступ к оповещениям об ответах пользователю.
     NOTIFICATIONS = 2**19
-    """Доступ к оповещениям об ответах пользователю."""
+
+    #: Доступ к статистике групп и приложений пользователя, администратором которых он является.
     STATS = 2**20
-    """Доступ к статистике групп и приложений пользователя, администратором которых он является."""
+
+    #: Доступ к email пользователя.
     EMAIL = 2**22
-    """Доступ к email пользователя."""
+
+    #: Доступ к товарам.
     MARKET = 2**27
-    """Доступ к товарам."""

vk_api/execute.py

@@ -45,10 +45,10 @@ def compile(self, args):
         return self._minified_code % compiled_args
 
     def __call__(self, vk, *args, **kwargs):
-        r"""
+        """
         :param vk: VkApi или VkApiMethod
         :param \*args:
-        :param \**kwargs:
+        :param \*\*kwargs:
         """
 
         if not isinstance(vk, (VkApi, VkApiMethod)):