Результаты поиска по запросу "python-sphinx"
@mzjn Да, но нетрудно перенести его на Python 2.
ользую функцию автодока Sphinx для документирования своего API. Пример: DEFAULT_OPTION = 'default' def do_something(msg, option=DEFAULT_OPTION): print msgСгенерированная документация теперь показывает следующую подпись: do_something(msg, ...
Когда я первоначально разместил вопрос, я посмотрел на него, но он выглядит как слишком сложное решение для того, чтобы просто делать то, что мне нужно ... Почему вы думаете, что это будет "лучшим способом"?
ользуюсфинкс [http://sphinx.pocoo.org/index.html]создать документацию для моего проекта. В этом проекте я опишу список доступных команд вYAML [http://yaml.org]файл, который после загрузки приводит к появлению словаря в форме{command-name ...
Спасибо за ответ. Я действительно надеялся на документальное решение, которое не включало бы изменение фактического источника проекта.
ользую Sphinx для генерации документации из кода. Кто-нибудь знает, есть ли способ управления форматированием чисел с плавающей запятой, сгенерированных из аргументов по умолчанию. Например, если у меня есть следующая функция: def f(x = 0.97): ...
reStructured Text (Sphinx): подстановка в имени файла?
Я хочу создать несколько файлов из одного шаблона, которые отличаются только именем переменной. Например : (File1.rst): .. |variable| replace:: 1 .. include template.rst(template.rst): Variable |variable| ===================== Image ------- .. ...
автомодуль sphinx: как ссылаться на классы в одном модуле?
Я пытаюсь использовать сфинксаавтодок [http://sphinx.pocoo.org/ext/autodoc.html] расширение и, в частности, директива automodule для автоматического создания документации для приложения django, над которым я работаю. Проблема в том, что я хочу ...
Анализ файлов .rst с помощью специфических для Sphinx директив
Я хотел бы иметь возможность проанализировать первый в Python на основе sphinx для дальнейшей обработки и проверки. Что-то вроде: import sphinx p = sphinx.parse("/path/to/file.rst") do_something_with(p)Похоже, что-то возможно в documenttils с ...
Как добавить лишние пробелы между заголовком раздела и абзацем
Я хочу иметь больше места между заголовком и абзацем и между абзацами. Я не хочу, чтобы это был глобальный параметр, но я хочу использовать его там, где и когда это необходимо. Ценю любые предложения.
Как показать атрибуты экземпляра в Sphinx Doc?
Есть ли способ, как автоматически показывать переменныеvar1а такжеvar2и их значения init в документации sphinx? class MyClass: """ Description for class """ def __init__(self, par1, par2): self.var1 = par1 * 2 self.var2 = par2 * 2 def ...
Значения сфинкса для атрибутов, указанных как None
Когда я использую автодок Sphinx для документирования класса, значения атрибутов всегда сообщаются (как говорится,Вот [http://sphinx.pocoo.org/latest/changes.html]под # 437) но всегда как "= Нет" Attribute = None Some DocumentationЯ включаю это ...
Могу ли я подавить расширение переменных в документации Sphinx?
В моем коде у меня есть X_DEFAULT = ['a', 'long', 'list', 'of', 'values', 'that', 'is', 'really', 'ugly', 'to', 'see', 'over', 'and', 'over', 'again', 'every', 'time', 'it', 'is', 'referred', 'to', 'in', 'the', 'documentation']и позже def ...