0
ответов

Как создать индекс Sphinx из определенного или пользовательского элемента docstring?

Можно ли создать индекс в Sphinx, который создается конкретными (или настраиваемыми) элементами в docstring? Например, у меня есть следующая функция и хотелось бы, чтобы Sphinx создал ...
вопрос задан: 13 July 2018 06:36
0
ответов

Включение строки документации в документацию Sphinx

Я хотел бы включить только строку документации определенной функции в мою документацию Sphinx. Однако, похоже, нет возможности просто отобразить эти детали без ассоциированного класса и функции ...
вопрос задан: 23 May 2017 12:24
0
ответов

Sphinx autodoc выдает ПРЕДУПРЕЖДЕНИЕ :py :цель ссылки на класс не найдена :тип предупреждения

У меня есть код, который использует метакласс в python. Но когда запускается sphinx autodoc, он выдает ошибку :WARNING :py :class reference target not found :type Ошибка возникает в строке...
вопрос задан: 9 May 2015 14:28
0
ответов

Сделать Read Docs включающим документацию autodoc для специальных пользователей?

У меня есть модуль с двумя задокументированными глобальными специальными членами. Запуск Sphinx локально создает документацию, которая включает их документы, а Read the Docs - нет. Он использует документацию встроенного типа ...
вопрос задан: 17 January 2015 20:41
0
ответов

атрибуты автокласса и экземпляра

Согласно документации sphinx, директива .. autoattribute должна иметь возможность документировать атрибуты экземпляра. Однако, если я сделаю:: .. currentmodule:: xml.etree.ElementTree .. autoclass:: ...
вопрос задан: 26 June 2012 16:18
0
ответов

Использование sphinx autodoc для fabfile

Можно ли использовать Sphinx autodoc для создания документации для моего fabfile из строк документации функций? Например. для файла fabfile, содержащего задачу setup_development, я пробовал: .. automodule :: fabfile ...
вопрос задан: 13 January 2012 15:51
0
ответов

Как мне исключить jar-файлы из проекта leiningen?

При использовании Leiningen я получил следующую резкую ошибку: Исключение в потоке "main" java.lang.NoSuchMethodError: org.apache.tools.ant.util.FileUtils.getFileUtils () Lorg / apache / tools / ant / util / FileUtils; ...
вопрос задан: 6 August 2011 18:26
0
ответов

Можно ли переопределить автодок Sphinx для определенных функций?

Я использую Sphinx ' s плагин autodoc для автоматического документирования набора модулей. У меня есть функция, которая принимает * args, и я хотел бы переопределить документацию, чтобы показать немного более удобное имя функции (arg1 [...
вопрос задан: 18 July 2011 16:33
0
ответов

Как использовать автодок Sphinx для документирования метода __init __ (self) класса?

По умолчанию Sphinx не создает документы для __init __ (self) . Я пробовал следующее: .. automodule :: mymodule: members: и ..autoclass :: MyClass: members: В conf.py установка ...
вопрос задан: 18 July 2011 16:27