dm.zdoc egy kis Python wrapper körül pydoc, hogy ez felhasználható Zope.
Megjegyzés: Python verziók alatt 2.6 nincsenek jó támogatást névtér csomagok pydoc. Míg Zope önmagában nem használhatja névtér csomagok előtti verzió 2.12 (mely Python 2.6), fontos Zope alkalmazások (például a Plone), használják is névtér csomagokat. Ezekben az esetekben a dokumentáció által termelt pydoc (és tágabb zdoc) hiányos.
Használat
zdoc egyaránt lehet használni keresztül script dmzdoc keresztül modul import- vagy integrálható egy futó Zope például.
Az első két esetben lehet, hogy be kell állítani a Zope környezeti változók INSTANCE_HOME és SOFTWARE_HOME mondani zdoc ahol a Zope források találhatók.
Használja keresztül dmzdoc
A script dmzdoc voltak telepítve van setuptools telepítve.
Máskülönben be kell telepíteni magát. Ez a következő tartalommal:
import dm.zdoc; dm.zdoc.cli ()
dmzdoc van pontosan ugyanolyan lehetőségeket és paraméterekkel pydoc, dokumentált pydoc.
Használja keresztül modul import
A modul dm.zdoc meghatározza az azonos célokat pydoc, dokumentált pydoc.
Integrált egy futó Zope például
Ilyen célra, telepíteni kell a modul a Zope telepítési és aktiválja a configure.zcml a Zope induláskor. Ez adja a "Zope Root Folder" a véleményen@@zdoc bemutató dokumentációt ugyanúgy, mint a pydoc http szerver.
FIGYELEM: Ne érje a dokumentációt a Zope például ilyen módon nyújt betekintést értelmes és adhat hackerek értékes nyomokat a támadásokat. Valószínű, akkor telepítse ezt csak fejlesztési esetekben korlátozott hozzáférésű.
Mi az új ebben a kiadásban:
- Támogatás A & quot; integrálva a runnging Zope például & quot; használata esetén
követelmények :
- Python
Hozzászólás nem található