python-sphinx- все статьи тега
Интеграция Sphinx и Django для того, чтобы пользователи могли войти в систему для просмотра документации
Мне интересно, можно ли спрятать документацию sphinx внутри приложения django, чтобы ее могли видеть только те, кто вошел в систему. Мне кажется, что поскольку sphinx создает свою собственную структуру и что Django использует urlconf для определения того, какие страницы пользователь может видеть, то объединить их невозможно. Хотя должно быть какое-то сочетание, так как сайт Django, вероятно, использует django и sphinx. Мне интересно, есть ли у кого-нибудь какое-то озарение или они могут указа ...
Как использовать autodoc Сфинкса для документирования метода init (self) класса?
Sphinx не создает документы для __init__(self) по умолчанию. Я пробовал следующее: .. automodule:: mymodule :members: и ..autoclass:: MyClass :members: В conf.py установка следующим добавляет только в __инит__(самостоятельная) строкой документации для строкой документации класса (документация Sphinx autodoc кажется, согласны, что это ожидаемое поведение, но ничего не упоминает о проблеме, которую я пытаюсь разгадать): autoclass_content = 'both' ...
Как документировать код Python с помощью doxygen [закрыто]
Мне нравится doxygen для создания документации C или PHP кода. У меня есть предстоящий проект Python, и я думаю, что помню, что Python не имеет /* .. */ комментарии, а также будет иметь собственную документацию объекта, который, кажется, быть подходящие для Python путь к документу. поскольку я знаком с doxygen, как я могу использовать его для создания моей документации Python? Есть ли что-то особенное, что мне нужно знать? ...
Как правильно документировать параметр * * kwargs? [закрытый]
Я использую сфинкс и плагин autodoc для создания документации API для моих модулей Python. Хотя я вижу, как красиво документировать определенные параметры, я не могу найти пример того, как документировать a . у кого-нибудь есть хороший пример четкого способа документировать их? ...