dm.zdoc

dm.zdoc jest małe Python otoki wokół pydoc by działał na Zope.
Uwaga: Python poniżej 2,6 wersje brakuje dobre wsparcie dla przestrzeni nazw w pydoc pakietów. Choć sama Zope nie używa pakietów przestrzeni nazw wersji 2.12 (przed który korzysta Python 2.6), ważnych aplikacji Zope (takie jak Plone) nie używać pakietów przestrzeni nazw. W tych przypadkach, dokumentację wytwarzać pydoc (i wydłużania zdoc) jest niekompletny.
Zastosowanie
zdoc mogą być wykorzystywane albo poprzez dmzdoc skryptu, za pomocą modułu importu lub zintegrowany w działającej instancji Zope.
W dwóch pierwszych przypadkach może być konieczne, aby ustawić zmienne środowiskowe INSTANCE_HOME Zope i SOFTWARE_HOME powiedzieć zdoc, gdzie można znaleźć źródła Zope.
Użyj poprzez dmzdoc
Dmzdoc skrypt jest zainstalowany, gdy masz zainstalowane setuptools.
W przeciwnym razie, należy je zainstalować samodzielnie. To ma następującą treść:
dm.zdoc importu; dm.zdoc.cli ()
dmzdoc ma te same opcje i parametry, jak pydoc, udokumentowane w pydoc.
Użyj poprzez module import
Moduł dm.zdoc definiuje te same obiekty jak pydoc, udokumentowane w pydoc.
Zintegrowany w działającej instancji Zope
Dla tego zastosowania, należy zainstalować moduł w instalacji i aktywacji jego Zope przy starcie Zope configure.zcml. To daje "Zope Root Folder" widoku@@zdoc który przedstawia dokumentację w taki sam sposób jak serwer pydoc http.
Uwaga: Wystawienie dokumentacji instancji Zope w ten sposób zapewnia rozsądne spojrzenie i może dać hakerom cenne wskazówki dla ataków. Prawdopodobny zainstalujesz to tylko w przypadkach rozwoju z ograniczonym dostępem

Co nowego w tym wydaniu:.

• Wsparcie dla & quot; zintegrowane w runnging Zope instancji & quot; przypadek użycia

Wymagania :

• Python