python-sphinx — все вопросы

1ответ
10 голосов
Python-Sphinx: как документировать один файл с функциями?
У меня есть файл Python с функциями (lib.py), без классов. Каждая функция имеет следующий стиль: def fnc1(a,b,c): ''' This fonction does something. :param a: lalala :type a: str
1ответ
11 голосов
Сфинкс: список функций в модуле
У меня есть несколько модулей Python, содержащих в основном функции и несколько классов. Каждый документ документирован с использованием sphinx-autodoc в отдельном файле. Я хочу создать таблицу или
2ответа
11 голосов
В reStructuredText, как поместить встроенный литерал внутри гиперссылки?
В моем документе reStructuredText у меня есть раздел, определенный следующим образом: Update the ``PATH`` Environment Variable ---------------------------------------- Я бы хотел добавить ссылк
1ответ
12 голосов
Автодок Sphinx выдает ПРЕДУПРЕЖДЕНИЕ: py: ссылка на класс не найдена: предупреждение типа
У меня есть код, который использует метакласс в Python. Но когда запускается автодок sphinx, он выдает ошибку: WARNING: py:class reference target not found: type Ошибка в строке автоматически
4ответа
12 голосов
Включите специальные специальные методы в sphinx
У меня есть куча классов, которые используют "специальные методы": class Foo(object): "Foo docstring" attr1 = "Attribute!" #: first attribute attr2 = "Another Attribute!" #: second attri
1ответ
13 голосов
Документ Python с использованием Eclipse /Pydev
Я новичок в разработке на Python и использую Eclipse /Pydev. Есть ли хороший способ интегрировать инструменты для создания документации (например, Sphinx, pydoc) в IDE, чтобы иметь хороший рабочий пр
2ответа
13 голосов
Можно ли скрыть аргументы функции Python в Sphinx?
Предположим, у меня есть следующая функция, описанная в стиле Numpydoc и документация создается автоматически с помощью Sphinx директива автофункции : def foo(x, y, _hidden_argument=None):
1ответ
13 голосов
Как создавать пользовательские директивы в Sphinx
В настоящее время я документирую API отдыха, написанный на Python. Вся документация проекта создается с использованием Sphinx, и для REST API я хотел бы создать несколько специальных директив. Напри
2ответа
13 голосов
Сфинкс сообщает о неработающих ссылках
Как при создании html-документации вы заставляете sphinx сообщать или создавать ошибку по несуществующим ссылкам? В частности, у меня есть свойства и методы в моем проекте Python, которые были уд
1ответ
13 голосов
Автосуммарная ошибка Python sphinx
У меня есть документ сфинкса, и когда я включаю следующие строки: .. currentmodule:: myMod .. autosummary:: MyClass Я получаю следующую ошибку ERROR: Unknown directive type "autosummary".
2ответа
13 голосов
Сфинкс: как исключить импорт в автомодуле?
У меня есть проект Raspberry Pi, написанный на Python, в котором используется модуль RPi.GPIO. Вся работа над кодом выполняется на коробке с Windows, где RPi.GPIO не устанавливается, и каждый раз, к
1ответ
14 голосов
Sphinx-apidoc в hjml-сборке django для `django.core.exceptions.AppRegistryNotReady`
Фон вопроса: Я хочу писать документы с помощью sphinx в моем проекте django и автоматически создавать документы с моими комментариями к коду django. Теперь у меня есть проект django (1.9), стр
2ответа
16 голосов
Как документировать параметры функции Python с помощью sphinx-apidoc
Я пытаюсь очистить документацию по коду Python и решил использовать sphinx- Док потому что выглядит хорошо. Мне нравится, как я могу ссылаться на другие классы и методы с помощью тегов, таких как:
2ответа
16 голосов
Как вывести значение конфигурации в файл Sphinx .rst?
У меня есть следующее в conf.py: def setup(app): app.add_config_value('base_url','http://localhost:2000', True) Как мне вставить это в мои файлы .rst? Я написал это: :base_url:/my_app/api
3ответа
16 голосов
Как загрузить HTML-документацию, созданную из sphinx, на github?
Я только что задокументировал загрузки своего кода и узнал, как использовать sphinx для генерации документации. Я хочу включить это в свою страницу проекта github, но я не знаю, как это сделать. Кто
4ответа
18 голосов
Рабочий пример плавающего изображения в реструктурированном тексте
Я ищу лучший способ, чтобы изображение с текстом, появляющимся рядом с ним в реструктурированном тексте. Я нашел несколько сайтов, нацеленных на то, чтобы показать, как это делается, но ни один из н
4ответа
18 голосов
Замены внутри ссылок в reST /Sphinx
Я использую Sphinx для документирования веб-сервиса, который будет развернут на разных серверах. Документация полна примеров URL, по которым пользователь может щелкнуть, и они должны просто работать
3ответа
18 голосов
Как сделать внутреннюю ссылку на заголовок в sphinx restructuredtext без создания произвольных меток?
У меня есть документ со многими заголовками и подзаголовками. Далее в тексте я хочу сослаться на один из заголовков. Как я могу сделать это без избыточности меток :ref:? Кажется, что содержимое отлич
2ответа
20 голосов
Выдать reStructuredText из sphinx autodoc?
CPython не использует autodoc для своей документации - мы используем рукописную прозу. Для PEP 3144 (модуль ipaddress) я хотел бы использовать sphinx-apidoc для генерации исходной справочной доку
1 2

Популярные теги

security × 330linux × 316macos × 2827 × 268performance × 244command-line × 241sql-server × 235joomla-3.x × 222java × 189c++ × 186windows × 180cisco × 168bash × 158c# × 142gmail × 139arduino-uno × 139javascript × 134ssh × 133seo × 132mysql × 132