0
ответов
Включите специальные специальные методы в sphinx
У меня есть куча классов, которые используют «специальные методы»: class Foo (object): "Foo docstring" attr1 = "Attribute!" #: first attribute attr2 = "Другой атрибут!" #: второй атрибут def ...
вопрос задан: 10 April 2013 01:42
0
ответов
Как сослаться на задокументированный параметр функции Python с помощью разметки Sphinx?
Я хотел бы сослаться на ранее задокументированный параметр функции в другом месте строки документации Python. Рассмотрим следующий (по общему признанию, полностью искусственный) пример: def foo(bar): """Perform foo ...
вопрос задан: 8 February 2013 09:24
0
ответов
sphinx -сбой сборки -autodoc can& #39;t import/find module
Я пытаюсь начать работу со Sphinx и, похоже, постоянно испытываю проблемы. Команда :docs/sphinx -quickstart Отвечаю на все вопросы и все работает нормально. Команда :docs/ls Все выглядит...
вопрос задан: 8 February 2013 09:23
0
ответов
Как сделать ссылку на файл в первую очередь с помощью sphinx?
Я пишу документацию, и я хотел бы включить ссылки на PDF-файлы или ZIP-архивы. Как я могу добиться этого с помощью первого языка и сфинкса? Если я сделаю это, вот файл pdf: `pdf < doc / ...
вопрос задан: 15 January 2013 20:05
0
ответов
Как собрать всего один файл с помощью sphinx
Для быстрого предварительного просмотра я хочу создать только один файл, а не весь проект. Можно со сфинксом? Недавно я сделал что-то вроде :sphinx -build -b html documentation/ doc _html спасибо
вопрос задан: 16 August 2012 22:19
0
ответов
Как изменить в документации Sphinx, чтобы относительные ссылки обновлялись?
Я использую Sphinx для документирования проекта Python. Я использую холст для визуализации некоторых результатов в документации. Моя документация должна поддерживать Firefox и IE. Мне нужно включить excanvas.js...
вопрос задан: 7 August 2012 20:36
0
ответов
Sphinx заменяет текст строки документации
Я документирую код в Sphinx, который напоминает этот :class ParentClass (object ):def __init __(self ):pass def generic _fun (self ):""" Вызовите эту функцию, используя /run/ParentClass/...
вопрос задан: 1 August 2012 03:10
0
ответов
RestructuredText - добавление атрибутов заголовка к ссылкам
Я пытаюсь использовать на своем веб-сайте реализацию jQuery lightBox, созданную из reStructuredText. LightBox принимает заголовок ссылки вокруг изображений как заголовок изображения в ...
вопрос задан: 30 July 2012 08:50
0
ответов
Sphinx, используя автомодуль для поиска подмодулей
При использовании автомодуля sphinx(http://sphinx.pocoo.org/ext/autodoc.html#directive-automodule), я просто записываю в.rst файл :.. автомодуль ::мой _модуль :члены :Он документирует мой _модуль в порядке,...
вопрос задан: 16 July 2012 19:06
0
ответов
Doxygen для многоязычного -API
Моя компания разрабатывает API для инженерных программ. Он разработан на C++, но мы создаем его оболочки для следующих языков :собственный язык, напоминающий VB МАТЛАБ и Питон....
вопрос задан: 12 July 2012 08:26
0
ответов
Использование Sphinx apidoc для создания документации из кода C++
В прошлом было несколько тем на эту тему, в которых утверждалось, что Sphinx вообще не поддерживает это. У меня были сомнения, но либо он был обновлен с тех пор, либо документация для него была довольно...
вопрос задан: 29 June 2012 16:53
0
ответов
атрибуты автокласса и экземпляра
Согласно документации sphinx, директива .. autoattribute должна иметь возможность документировать атрибуты экземпляра. Однако, если я сделаю:: .. currentmodule:: xml.etree.ElementTree .. autoclass:: ...
вопрос задан: 26 June 2012 16:18
0
ответов
Существуют ли реальные альтернативы документации reStructuredText для Python? [закрыто]
В ближайшее время я начинаю проект Python с открытым исходным кодом и пытаюсь заранее решить, как писать свои строки документации. Очевидным ответом было бы использование reStructuredText и Sphinx с autodoc, потому что я...
вопрос задан: 24 June 2012 04:37
0
ответов
Размещение частной документации Sphinx [закрыто]
В настоящее время я пишу обширную документацию, используя Sphinx, для довольно сложного веб-сайта Django. Я работал над этим в доме -и, прежде чем я скоро уеду, я хочу оставить подробное...
вопрос задан: 19 June 2012 18:13
0
ответов
Свежая установка краткого руководства sphinx терпит неудачу
Попытка запустить его с Помощью Sphinx в первый раз, с чистой установкой Sphinx 1.1.3, и shinx-quickstart терпит неудачу. Должны ли быть установлены какие-либо зависимости? Я попытался pip --force-переустановить ...
вопрос задан: 7 June 2012 15:44
0
ответов
Sphinx и argparse - автодокументирование сценариев командной строки?
Я создаю пакет Python и использую Sphinx для создания документации. Помимо моего кода пакета, я также включаю множество скриптов командной строки Python, которые используют argparse. Мне интересно, есть ли...
вопрос задан: 6 June 2012 11:56
0
ответов
Рабочий пример плавающего изображения в повторно структурированном тексте
Я ищу лучший способ получить изображение с текстом рядом с ним в повторно структурированном тексте. Я нашел несколько сайтов, претендующих на то, чтобы показать, как это делается, но ни один из них не показывает фактическое функционирование ...
вопрос задан: 5 June 2012 12:29
0
ответов
Sphinx, literalinclude, lnenos: как отобразить фактические номера строк из файла исходного кода во фрагменте кода документа?
Я использую Sphinx для документирования частей кода Javascript на веб-странице. Я использую .. literalinclude :: ../examples/mapviz-step1-simple.html: language: javascript: lines: 47-51: cabinos: Я получаю ...
вопрос задан: 1 June 2012 00:51
0
ответов
Django и Sphinx — как просмотреть HTML, который генерирует Sphinx?
Хорошо. У меня есть проект Django, который я хочу задокументировать, поэтому я установил Sphinx. Установка прошла нормально, и я могу вывести весь HTML-код в папку _build. Но... Вопрос в том, как мне на самом деле просмотреть...
вопрос задан: 23 May 2012 12:03
0
ответов
Самый простой способ запустить Sphinx на одном файле Python
У нас есть конфигурация Sphinx, которая будет генерировать множество HTML-документов для всей нашей кодовой базы. Иногда я работаю над одним файлом, и мне просто хочется увидеть вывод HTML из этого файла, чтобы сделать...
вопрос задан: 21 May 2012 23:15
0
ответов
Как заставить sphinx искать модули в virtualenv при создании html?
Я хочу создавать html-документы, используя virtualenv вместо родной среды на моем компьютере. Я вошел в virtualenv, но когда я запускаю make html, я получаю сообщение об ошибке, в котором говорится, что модуль не может быть импортирован - ...
вопрос задан: 8 May 2012 13:19
0
ответов
Emit reStructuredText из sphinx autodoc?
CPython не использует autodoc для своей документации -мы используем написанную от руки -прозу. Для PEP 3144 (модуль ipaddress )я хотел бы использовать sphinx -apidoc для создания исходной справочной документации. Это...
вопрос задан: 30 April 2012 01:37
0
ответов
Документация по общедоступному API Sphinx
У меня есть большое количество файлов Python, и я хотел бы создать общедоступную документацию по API для своего проекта. Все функции, входящие в состав апи, я украсил декоратором. например :...
вопрос задан: 27 April 2012 11:49
0
ответов
Использование '\displaymath' директивы в строках документации формулы
Я использую пакет документации Sphinx для документирования небольшого набора инструментов Python, над которым я работаю, и я хотел бы описать математические формулы, которые реализуют различные модули, с помощью...
вопрос задан: 19 April 2012 13:48
0
ответов
Сетка изображений в reStructuredText / Sphinx
Я использую Sphinx для создания документации для проекта Python Я работаю на. У меня есть три изображения, которые я хотел бы отобразить в сетке 1x3 (т. е. все в одной строке), и я пытаюсь понять, как...
вопрос задан: 19 April 2012 02:43
0
ответов
Как использовать Sphinx с Cython?
Недавно я переименовал свой проект на Cython, переименовав все модули (кроме __init__.py верхнего уровня) в *.pyx и добавив ext_modules = [Extension('foo', ['foo.pyx '])] в setup.py. ...
вопрос задан: 7 April 2012 19:08
0
ответов
Python Sphinx ссылается на длинные имена
Я работаю над документацией для своего модуля Python (используя Sphinx и reST), и я обнаружил, что при перекрестных ссылках на другие Python объекты (модули, классы, функции и т. д.), полное имя объекта заканчивается ...
вопрос задан: 6 April 2012 02:26
0
ответов
Автоматический способ переключения с форматирования строки документации epidoc на форматирование строки документации sphinx?
У меня есть проект, который я задокументировал с помощью epydoc. Сейчас пытаюсь перейти на сфинкс. Я отформатировал все свои строки документации для эпидоков, используя B{}, L{} и т. д. для выделения жирным шрифтом, связывания и т. п., а также использовал
вопрос задан: 4 April 2012 15:57
0
ответов
Настройка параметров Django для sphinx (документация)
У меня есть приложение Django, для которого я пытаюсь настроить документацию. . Структура каталогов следующая: -doc
- проект
| - manage.py Я настроил пути так, чтобы Sphinx мог что-то видеть, но когда я пытаюсь...
вопрос задан: 24 March 2012 10:16
0
ответов
Автоматически генерировать вывод doctest с расширением Sphinx
Мне кажется, я что-то упускаю из расширения sphinx для doctest. Типичный пример в документации: :.. doctest::>>> print 1 1 Нет ли способа разрешить sphinx...
вопрос задан: 21 March 2012 17:31