Альтернативные способы просмотра python api

Является ли это просто мной, или документация по стандартной библиотеке python чрезвычайно трудно просмотреть?Альтернативные способы просмотра python api

Java имеет свой блестящий Javadocs, Ruby имеет полезный Ruby-Docs, только в питоне я не могу найти хороший способ перемещаться по стандартной документации библиотеки.

Проект Epydoc, который выглядит красиво, но кто-нибудь знает, действительно ли он используется в стандартной библиотеке, поэтому мы все можем пройти через него? Если нет, то какие альтернативы люди используют для просмотра документации python.

источник

2010-01-25 ivo

Python и многие из больших библиотек используют Sphinx для документации. С точки зрения удобства использования сгенерированные документы выглядят довольно ужасно (хотя они используют какой-то красивый CSS). Одним из примеров этого являются чрезвычайно длинные страницы, что делает просмотр очень сложным. – nikow

Wow ... Python может быть не самым замечательным документом, но неблагоприятно сравнивать его с * javadoc *? Документ - это в значительной степени моя наименее любимая вещь в Java: вы обычно получаете небольшой поверхностный учебник, а затем после этого есть только javadoc: бесполезный лабиринт технических характеристик класса и метода без каких-либо указаний по поиску того, как все устроено, Ожидается, что он будет использоваться. – bobince

Я нахожу javadocs отличным инструментом для просмотра API. Качество самой документации не несет ответственности за инструмент, а от автора документации. Итак, IMHO, да, javadocs намного лучше того, что использует официальный сайт документации python. – ivo

Обычно я использую встроенный pydoc, если вы на окнах, его следует называть Документами по модулю, если вы используете linux для использования pydoc -p 8000 и подключаетесь через браузер.

источник

2010-01-25 10:30:29

вы можете перейти на here и загрузить версию chm версии Python 3.1. При этом поиск в документах должен быть простым.

источник

2010-01-25 10:02:04 ghostdog74

pydoc из командной строки, help() из приглашения интерактивного интерпретатора.

источник

2010-01-25 10:32:36

pydoc -p 8080

Питон сообщество полу-враждебное автоматически сгенерированную документацию, особенно если это объектно-ориентированное. Python не просто объектно ориентирован (это язык с несколькими парадигмами), поэтому разработчики Python обычно предпочитают документацию, написанную человеком. Иногда функции важны, иногда важна структура класса.

источник

2010-01-25 10:42:35 wisty

Да, я пробовал некоторые из враждебности ... – ivo

Раньше я использовал python sidebar от Edgewall.

В настоящее время я использую функцию python (стандартные документы почти всегда отображаются как первая ссылка). Если я хочу просмотреть источник модуля (иногда полезно), я использую эту небольшую функцию оболочки, которую я написал ,

epy() { 
    cmd="import $1 as a ; print a.__file__.endswith('.pyc') and a.__file__[:-1] or a.__file__" 
    file=$(/usr/bin/env python -c $cmd) 
    echo $file 
    emacsclient --no-wait $file 
}

источник

2010-01-25 10:45:31

Я предполагаю, что я собираюсь получить downvoted, но я не нахожу ничего плохого с Docs сфинкса, и я нахожу их путь лучше, чем Java альтернативы.

источник

2010-01-30 09:14:42

Согласен. Sphinx - хороший инструмент, и он создает хорошие документы. По крайней мере для Python :) –

Альтернативные способы просмотра python api

ответ

Смежные вопросы