Результаты поиска по запросу "python-sphinx"
Как переопределить параметры конструктора в Sphinx с помощью autodoc?
Допустим, у меня есть такой класс: class MyClass(object): """ Summary docs for my class. Extended documentation for my class. """ def __init__(self, *args): self.values = np.asarray(args)Если я использую Сфинкс сautodoc расширение для ...
Сфинкс - объединение автомодуля и автокласса
Если я что-то упустил, Сфинксautomodule будет только документировать членов модуля, а не атрибуты классов, определенных в этом модуле. Есть ли способавтоматически получить поведениеautomodule а такжеautoclass объединены таким образом, что я могу ...
Ссылка на параметры в строке документации Python
Я использую Sphinx и функцию autodocs, чтобы у нас были хорошие документы в нашем проекте. Итак, я знаком ссписки информационных полей [http://sphinx-doc.org/domains.html#info-field-lists]и я знаком с использованием перекрестные ...
Как сделать ссылку на файл в первую очередь с помощью sphinx?
Я пишу документацию, и я хотел бы включить ссылки на PDF-файлы или ZIP-архивы. Как я могу добиться этого с помощью первого языка и сфинкса? Если я сделаю это here is a pdf file : `pdf <doc/mypdf.pdf>`_Это не работает, потому что во ...
Сортировка отображения по классу с использованием sphinx с 'autodoc'?
Есть ли способ отобразить список / вкладку «Классы» с помощью Sphinx или организовать html-страницы, созданные для отображения членов по классам, при этом классы визуально хорошо разделены? Я использую Sphinx 1.1.3, попытку документировать ...
Как мне документировать классы без имени модуля?
Я пытаюсь документировать пакет Python сsphinx и успешно сгенерировал HTML-файлы. Пакет, который я документирую, состоит из набора*.py файлы, большинство из которых содержат один класс с парой файлов, являющихся подлинными модулями с ...
Программа командной строки Python: сгенерируйте man-страницу из существующей документации и включите в дистрибутив
Следуя (надеюсь) общепринятой практике, у меня есть пакет Python, который включает в себя несколько модулей и исполняемый скрипт в отдельномscripts каталог, как видноВот [http://bitbucket.org/steko/totalopenstation/src]. Документация для ...
Добавление перекрестной ссылки на подзаголовок или привязку на другой странице
Как вставить перекрестную ссылку на странице reST / Sphinx в подзаголовок или на якорь на другой странице в том же наборе документации?
Свойства модуля документа Sphinx
У меня есть модуль, который должен иметь@propertyЯ решил это, установив класс в качестве модуля. Я получил идею из этого ответа:Ленивые переменные модуля - это можно ...
Получение Github отдельных авторов файлов
Я планирую создать плагин для плагина системы документации Sphinx, который отображает имена и ссылки на профили Github людей, которые внесли свой вклад в страницу документации. Github имеет эту функцию внутри Можно ли получить ссылки на ...