Генерация документации Tastypie

Я пытаюсь использовать инструмент auto-doc для создания API-документа для tastypie REST API. Я попробовал tastytool, но, похоже, не отображает параметры результата api, а столбцы модели. Затем я попробовал Sphinx казаться более перспективным, поскольку Tastypie поддерживает Sphinx, но я не могу найти пример, чтобы показать, где и как поставить комментарий для API внутри кода, и сгенерировать их в документе.

Кто-нибудь может поделиться некоторой информацией или примером о правильном написании комментария и сгенерировать документ Sphinx для API на основе Tastypie? спасибо.

Ответ 1

Возможно, вы захотите взглянуть на tastypie-swagger, в котором используется Swagger, чтобы создать/doc/страницу для Tastypie API.

У меня был некоторый успех в этом, после нескольких незначительных изменений (которые были необходимы из-за разницы в версии тастипа, я полагаю).

Изменить: Адаптации, которые я нашел необходимыми (из-за версии django < 1.4 и версии tastypie > 0,9.11), теперь объединены в основную ветвь tastypie-swagger.

Ответ 2

Там также Django Tasty Docs, который является частью Вкусные инструменты

Ответ 3

Возможно, я полностью упустил точку вашего вопроса, но если вы просто пытаетесь создать документы, которые поставляются с исходным дистрибутивом, в каталоге docs есть Makefile, который выполняет необходимые действия. Вы должны указать целевой тип вывода, такой как html, json, latex и т.д. Я сохраняю локальную копию документов для django, tastypie и slumber, поскольку я использую все три совместно друг с другом, и я использую опцию make html часто.

Если я ошибаюсь в том, что вы пытаетесь достичь, возможно, мы сможем прийти к некоторым разъяснениям.