python-sphinx
Я использую docstrings и autodoc для создания документации для моего проекта с использованием Sphinx. Мне нравится иметь описания классов тестирования и реальных тестовых случаев в моей документации, но я хотел бы оставить установку и демонтаж. Я попытался уточнить это в своем .первый файл, но у меня это не с...
Используя Sphinx и reStructuredText, Можно ли определить математические макросы для выполнения подстановок в Формуле math Latex? В принципе, я хотел бы иметь что-то вроде .. |bnabla| replace:: :math:`boldsymbol{nabla}` .. |vv| replace:: :math:`textbf{v}` .. math:: rho mbox{D}_t |vv| = - |bnabla| p + rho...
Представив, что у меня есть модуль с именем module.py и внутри него есть частная переменная с именем _VAR, я хочу напечатать ее значение в моей документации sphinx. module.py _VAR = 20 А в "Сфинксе" я хочу что-то вроде этого: index.rst The value of ``module._VAR`` is :py:print:`module._VAR` И выход б...
Я пытаюсь создать документацию на python с помощью Sphinx. Проблема в том, что sphinx-build завершает выполнение модуля / оценку чего-либо в глобальном масштабе. Есть ли причина, по которой он это делает? И кто-нибудь знает о флаге, который можно установить, чтобы отключить это? Похоже, что Sphinx пытается с...
Я написал небольшой модуль, и я хотел бы знать, каковы основные шаги, чтобы упаковать его, чтобы отправить его в pypi: Что такое файловая иерархия? Как я должен называть файлы? должен ли я использовать distutils для создания PKG-INFO? куда я должен включить свою документацию (сделанную с помощью sphinx)? ...
Я ищу автономный сервер полнотекстового поиска со следующими свойствами: должны работать как автономный сервер, который может обслуживать запросы от нескольких клиентов должен быть способен выполнять "массовое индексирование" путем индексирования результата SQL-запроса: скажем " SELECT id, text_to_index FRO...
Я пытаюсь использовать Sphinx для документирования проекта 5,000 + line в Python. Она имеет около 7 базовых модулей. Насколько я знаю, для использования autodoc мне нужно написать такой код для каждого файла в моем проекте: .. automodule:: mods.set.tests :members: :show-inheritance: Это слишком уто...
Как вставить перекрестную ссылку на странице reST / Sphinx в подзаголовок или привязку на другой странице в том же наборе документации?...
как вы форматируете текст в обозначенной ссылке в reStructuredText? в частности, я хочу создать следующий HTML из моего первого: <a href="http://docs.python.org/library/optparse.html"><tt>optparse.OptionParser</tt> documentation documentation</a> результат должен выглядеть так: ...
Я создаю фреймворк, в котором я позволяю разработчикам описывать свой пакет с помощью reStructuredText. Я хочу разобрать этот реструктурированный текст в HTML, чтобы я мог показать его в графическом интерфейсе. Я знаком с отличным Сфинксом, но я никогда не анализировал реструктурированный текст. Я представил...