Просмотреть строки документации reStructuredText (Sphinx) в iPython?

Есть ли способ, чтобы IPython полностью отображал строки документации reStructuredText (для Sphinx), когда вы вводите следующее:

help foo

or:

foo?

Меня супер отвлекает попытка прочитать справочную документацию в IPython, когда она показывает необработанную разметку. reST отлично подходит для документации Sphinx, но действительно загромождает простой поиск в справке. Я не могу быть один на этом...?

Гугл в этом не помог.


python ipython python-sphinx restructuredtext docstring
person jkmacc    schedule 24.01.2012    source источник
comment
Насколько я знаю, еще нет. Вклад приветствуется - спросите в списках рассылки или IRC о том, с чего начать.   -  person Thomas K    schedule 25.01.2012
comment
Один из способов добавить эту функцию — преобразовать строку документации в HTML, а затем проанализировать и раскрасить (или просто распечатать текст) вывод.   -  person Ed L    schedule 05.03.2012
comment
Также есть конструктор текста для Sphinx, который может быть проще, чем использование HTML.   -  person Kevin Horn    schedule 21.03.2012
comment
Я согласен, просмотр строк документации sphinx в ipython не очень удобочитаем. Я попытался использовать Consolidated Fields в качестве компромисса: просмотр строк документации в интерпретаторе стал лучше, но некоторые полезные функции Sphinx были потеряны.   -  person Mark Mikofski    schedule 29.07.2013
comment
Обсуждалось: python.6 .x6.nabble.com/, но, насколько я знаю, ничего не реализовано.   -  person Wilfred Hughes    schedule 19.05.2014
comment
Спасибо за ссылку - очень обнадеживает. Я думаю, что Брайан Грейнджер сказал это лучше всего: Лично, если ноутбук сможет обрабатывать строки документации markdown+latex, я никогда не буду использовать reST для любого нового проекта. Я уже использую Markdown в строках документации вместо Sphinx, так как вижу несколько проектов, направленных на создание документации API из строк документации. Это, я думаю, единственное, для чего мне на данный момент нужен Sphinx.   -  person jkmacc    schedule 19.05.2014

Ответы (1)


arrow_upward
2
arrow_downward

Я не думаю, что это возможно в IPython, но взгляните на Spyder: вы можете откройте консоль IPython из среды IDE. Строки документации отображаются как HTML.

person bmu    schedule 12.04.2012