Pydoc — это стандартный модуль документации для языка программирования Python. Подобно функциональности Perldoc в Perl и Javadoc в Java, Pydoc позволяет программистам на Python получать доступ к файлам справки документации, генерировать текстовые и HTML-страницы с особенностями документации, и находить подходящий модуль для конкретной задачи.

Доступ к Pydoc можно получить через специфичный для модуля графический интерфейс,Using Pydoc. Accessed 11/27/2010 из интерпретатора Python или из оболочки командной строки.

Разработанный Ka-Ping Yee,, он включен по умолчанию во все версии Python, начиная с Python 2.1 и доступен для загрузки для версий 1.5.2, 1.6 и 2.0.

Pydoc используется для извлечения документации непосредственно из исходного кода. Более полная документация генерируется из внешних документов reStructuredText с помощью системы документирования Sphinx.

См. также

Примечания

External links Archive of Pydoc for Python versions 1.5 to 2.5 Open source package library for PyPI Sphinx documentation

Категория:Python Категория:Свободные генераторы документации