Sphinx documentation#125
Conversation
| :license: Apache License, Version 2.0, see LICENSE file | ||
|
|
||
| Copyright (C) 2018 | ||
| :copyright: (c) 2018 python273 |
There was a problem hiding this comment.
Хмм, кажется это какой-то дефолтный формат был, не уверен стоит ли менять
There was a problem hiding this comment.
Хотя думаю ок. Думаю еще можно добавлять краткое описание как в requests: https://github.com/requests/requests/blob/master/requests/api.py
| def save(self): | ||
| """ | ||
| Абстрактный метод, должен сохранять конфиг | ||
| """ |
There was a problem hiding this comment.
Лучше в одну строку такое
""" Something """
/
""" Something
:param ...
""""
| # 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' |
There was a problem hiding this comment.
Не уверен стоит ли ставить ru, там вроде как не все переведено, так что может оставить en 🤔
There was a problem hiding this comment.
имхо, лучше полторы непереведённые фразы от генератора доков, чем вообще весь интерфейс на одном языке, а сами доки - на другом
| api_version='5.73', app_id=6222115, scope=DEFAULT_USER_SCOPE, | ||
| client_secret=None): | ||
| # TODO: убрать config_filename, в качестве config брать объект, а не класс | ||
| # TODO: убрать auth_handler и captcha_handler - это должно происходить через наследование |
There was a problem hiding this comment.
Думаю их стоит оставить, они часто нужны
| config=jconfig.Config, config_filename='vk_config.v2.json', | ||
| api_version='5.73', app_id=6222115, scope=DEFAULT_USER_SCOPE, | ||
| client_secret=None): | ||
| # TODO: убрать config_filename, в качестве config брать объект, а не класс |
There was a problem hiding this comment.
Не уверен, что получится. Сейчас там передается секция: config(self.login, filename=config_filename). Хотя можно попробовать добавить смену секции в jconfig, но нужно ли 🤔
There was a problem hiding this comment.
В таком случае у тебя вроде бы и предполагается, что можно наследоваться от BaseConfig, и в то же время VkApi умеет создавать объект такого класса только когда у него в инициализаторе имя секции и имя файла.
There was a problem hiding this comment.
Да, но в .load могут любые kwargs прилететь, и BaseConfig принимает kwargs
|
В целом выглядит хорошо, может стоит в разные файлы вынести подмодули типа аудио, тулзы, лонгпул, етц |
|
Билд форка на RTFD http://vk-api-fork-hdk5.readthedocs.io/ru/docs/ |
|
И кстати, в основном классе обычно используются методы auth, get_api и, может быть, поле http. Нужна ли вообще документация по всему остальному? |
|
Раньше было лучше и думаю лучше оставить "Star" вместо "Watch" 😃
Я вот думаю стоит скрыть |
|
Поменял названия с "Модуль X" на названия классов, где предполагается использование только одного класса из файла |
|
Вроде все ок. Получается остается:
|
И орки зеленее. html_sidebars скопировал из документации к alabaster. Без навигации очень неудобно. Насчёт кнопки согласен, но нет нужды пихать свой html, это меняется прямо в настройках темы.
Сделаешь сам?
В индексе достаточно, думаю. |
2 participants
Здесь буду докладывать о работе над документацией