Я написал программу на Python 3 и использую Sphinx для ее документирования. Autodoc Sphinx великолепен, однако он работает только с Python 2. Некоторые модули прекрасно работают в autodoc, а модули — нет. Некоторые примеры: Python 2 жалуется на...

Я пытаюсь задокументировать проект Python с помощью Sphinx, но у меня возникают проблемы с объединением расширения autodoc с созданным namedtuple классом. В одном документе gammatone.rst у меня есть: :mod:`gammatone` -- gammatone...

У меня есть куча классов, которые используют "специальные методы": class Foo(object): "Foo docstring" attr1 = "Attribute!" #: first attribute attr2 = "Another Attribute!" #: second attribute def __init__(self): self.x = 12...

Я использую rST / Sphinx для документирования моего Python, однако при создании он выдает предупреждения, такие как ...Code/doc/code.rst:3: SEVERE: Duplicate ID: "module-toast". Мои исходные файлы Python задокументированы следующим образом:...

Я использую функцию Sphinx autodoc для создания документации на основе строк документации моей библиотеки Python. Синтаксис перекрестных ссылок можно найти здесь Метка должна предшествовать разделу, чтобы на этот раздел можно было...

Я пытаюсь использовать sphinx (вместе с autodoc и numpydoc ) для документирования моего модуля, но после базовой настройки запуск make html создает только базовый html без включенных строк документации. Я использую Python 3.3, схема структуры...

Я использую sphinx для документирования проекта, и у меня проблемы с функциями, заключенными в декораторы. Я видел похожие вопросы, но мне кажется, что нет решения, подходящего для моей проблемы У меня есть сотни функций, заключенных в...

У нас есть модуль, в котором каждый файл класса находится в файле, начинающемся с подчеркивания. В init .py мы импортируем эти файлы и предоставляем функции конструктора для каждого класса (это необходимо, поскольку каждому конструктору класса...

Я использую autodoc для документирования некоторых классов, и пока :members: , :private-members: и :special-members: дают мне именно то, что я хочу. Тем не менее, я также хотел бы видеть членов, которые унаследованы. Есть дополнительная...

В результате команды make html Sphinx генерирует документацию только для некоторых модулей. Другие модули остаются недокументированными. Структура проекта: |- my-project |--| my_project |--| docs |----| _build |------| ... |----| _static...

Как сделать строковый литерал с двоеточием в restructuredText? Я пытаюсь задокументировать функцию Python, которая возвращает словарь, например, что-то вроде: def function(...): """ ... Returns: A dictionary mapping ``{id:...

Использование Sphinx 2.2.0 и python 3.6.8 У меня есть два класса, A и B , и свойство A генерирует экземпляр B . Я хотел бы, чтобы мой вывод sphinx html ссылался на объект B , но я бы хотел, чтобы необработанная строка документации не имела...

Я хотел бы задокументировать атрибут модуля, который содержит вызываемый объект, а точнее тип. Этот атрибут предназначен для хранения некоторого типа, а не псевдонима типа. Когда я документирую атрибут, Sphinx по умолчанию отображает сигнатуру...