dm.zdoc大約pydoc一個微小的Python包裝,使其可用於Zope的。
注意:低於2.6版本的Python缺乏對於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安裝並激活它在Zope的啟動configure.zcml中。這將使“Zope的根文件夾”的觀點@@ zdoc其中介紹的方式相同pydoc HTTP服務器的文檔。
注意:揭露一個Zope實例文檔,以這種方式提供了合理的見解,並可能給黑客攻擊的有價值的線索。很有可能,你只會在限制訪問開發實例安裝此
什麼在此版本中是新的:
- 在用於支持在"集成在一個runnging的Zope實例"用例
要求:
- 在Python中
評論沒有發現