dm.zdoc

dm.zdoc je malý Python wrapper kolem pydoc, aby bylo použitelné pro Zope.
Poznámka: Python verze nižší než 2,6 nemají dobrou podporu jmenných prostorů balíčky v pydoc. Zatímco Zope sám nepoužívá namespace balíčky před verzí 2.12 (který používá Python 2.6), důležité aplikace Zope (například Plone) použijete jmenného prostoru balíčky. V těchto případech, dokumentaci produkoval pydoc (a potažmo zdoc), je neúplná.
Použít
zdoc lze použít buď pomocí skriptu dmzdoc, prostřednictvím dovozu modul nebo integrované v běžícím Zope instance.
V prvních dvou případech může být nutné nastavit Zope proměnné prostředí domovský_adresář_instance a SOFTWARE_HOME říct zdoc, kde lze nalézt zdroje Zope.
Použít přes dmzdoc
Skript dmzdoc je nainstalován, když máte setuptools nainstalovány.
V opačném případě je nutné jej nainstalovat sami. To má následující obsah:
import dm.zdoc; dm.zdoc.cli ()
dmzdoc Má stejné možnosti a parametry jako pydoc, popsané v pydoc.
Použijte přes import modul
Modul dm.zdoc definuje stejné objekty jako pydoc, popsané v pydoc.
Integrované ve spuštěném Zope instance
Pro toto použití, musíte nainstalovat modul ve vaší instalaci Zope a aktivovat jeho configure.zcml při spuštění Zope. To dá "Adresář Zope Root", názoru@@zdoc které představuje dokumentaci stejným způsobem jako pydoc http serveru.
POZOR: Vystavení dokumentaci instance Zope tímto způsobem poskytuje rozumné nahlédnutí a mohl dát hackerům cenná vodítka pro útoky. Pravděpodobně budete instalovat to nejen v rozvojových případech s omezeným přístupem

Co je nového v této verzi:.

• Podpora & quot; integrovaná do runnging Zope instance & quot; use case

Požadavky na :

• Python