Где находится источник документации для python? (и особенности документации spyder)

Где хранится документация для доступа к spyder (python IDE)?

Когда я набираю plot.savefig( в консоли spyder, я получаю всплывающее окно с документацией для savefig(). Это довольно приятная функция, но она исчезает, как только я перемещаю мышь. Откуда он берет эту документацию? Я искал папку /doc и не могу найти ничего, связанного с matplotlib. Я хотел бы открыть его в программе просмотра PDF на другом мониторе.

import matplotlib.pyplot as plt
plt.savefig()

Вот изображение документации для пояснения:

Изображение документа savefig


person SwimBikeRun    schedule 26.05.2014    source источник
comment
Вы ищете эту документацию или какую-то другую документацию? pythonhosted.org/spyder   -  person Anderson Green    schedule 27.05.2014


Ответы (3)


Документация, которую вы видите, взята из строк документации введенной вами функции. Вы можете получить необработанный текст с помощью plt.savefig.__doc__ или получить его с небольшим форматированием, используя встроенную команду help из интерактивного интерпретатора: help(plt.savefig). Spyder применяет дополнительное необычное форматирование к содержимому своего окна документации.

Степень детализации документации будет сильно различаться от модуля к модулю. В случае matplotlib он достаточно подробен, вероятно, потому, что сопровождающие приложили усилия, чтобы упростить использование этого пакета без большого опыта программирования.

Что касается вашего вопроса о том, как вы можете просматривать эти документы вне Spyder, я бы посоветовал поискать в Интернете. Я вижу на главной странице matplotlib обширную документацию, включая веб-страницы с тем же содержанием, что и документы, которые вы видели (предположительно, сгенерированные из тех же строк документации).

person Blckknght    schedule 26.05.2014
comment
А, спасибо за справочную информацию о функции doc. Ах, сайт отличный. Это не то, что я имел в виду для ответа, но это ответ. Спасибо - person SwimBikeRun; 27.05.2014

(Spyder dev здесь) Документация, которую вы имеете в виду, — это маленькая желтая рамка рядом с plt.savefig(, верно? Они называются всплывающими подсказками, и я исправил их в нашей следующей версии (2.3, сейчас в релиз-кандидате), чтобы они оставались на экране, если вы наведете на них указатель мыши, и скрывались, если вы нажимаете на них, или автоматически через определенное время.

Примечания:

  1. Это не работает в Spyder 2.2.5 или более ранних версиях.

О документации: Мы планируем добавить вкладки в инспектор объектов, чтобы вы могли просматривать несколько страниц документации одновременно.

person Carlos Cordoba    schedule 26.05.2014

Это может быть неактуально для вас сейчас, но теперь вы можете использовать ?plt.savefig. Это будет удобно для пользователей R, которые переходят на python в spyder, потому что оба используют один и тот же способ отображения документации.

person Rahul Sharma    schedule 29.11.2016