dm.zdoc крошечный оболочкой Python вокруг pydoc, чтобы сделать его пригодным для Zope.
Примечание: версии Python 2.6 ниже хватает хорошую поддержку для пространства имен пакетов в pydoc. В то время как сам Zope не использовать пространства имен пакетов до версии 2.12 (который использует Python 2.6), важных приложений Zope (такие как Plone) используем пакеты пространства имен. В этих случаях документация производится pydoc (и, zdoc) является неполным.
Использование
zdoc может использоваться либо с помощью сценария dmzdoc, с помощью импорта модуля или интегрирован в запущенном экземпляре Zope.
В первых двух случаях это может быть необходимо установить Zope переменные среды INSTANCE_HOME и SOFTWARE_HOME сказать zdoc где источники Zope может быть найдено.
Используйте с помощью dmzdoc
Сценарий dmzdoc установлен, когда у вас Setuptools установлены.
В противном случае, вы должны установить его самостоятельно. Он имеет следующее содержание:
импорт dm.zdoc; dm.zdoc.cli ()
dmzdoc имеет те же самые опции и параметры, как pydoc, описанные в pydoc.
Используйте с помощью импорта модуля
Модуль dm.zdoc определяет те же объекты, pydoc, описанные в pydoc.
Интегрированный в запущенном экземпляре Zope
Для этого использования, необходимо установить модуль в вашей системе Zope и активировать его configure.zcml при запуске Zope. Это даст "Zope корневую папку" Взгляд@@zdoc который представляет документацию таким же образом, как сервер HTTP pydoc.
ВНИМАНИЕ: Разоблачение документации экземпляра Zope таким образом предоставляет удобные идеи и дать хакерам может ценные подсказки для атак. Скорее всего, вы будете установить это только в тех случаях, развития с ограниченным доступом
Что нового В этом выпуске:.
- Поддержка & Quot; интегрирована в runnging Zope инстанции и Quot; кейс
Требования
- Python
Комментарии не найдены