我正在使用python 2.7,并尝试使用pdoc收集我们测试项目的文档。

pdoc位于此处:D:\ dev \ Python27 \ Scripts
此处的回归项目:C:\ views \ md_LDB_RegressionTests_v03.1_laptop \ mts \ Tests \ LDB \ Regression \ Tests
我们正在使用proboscis进行测试,我正在尝试为单独的一组测试创建html文档,在本例中为单独的python文件。
我运行这样的命令:

D:\dev\Python27\Scripts>python pdoc --html "C:\views\md_LDB_RegressionTests_v03.
1_laptop\mts\Tests\LDB\Regression\Tests\tests\check_system_management\check_capa
bilities_encoding_problems.py"


并得到这样的答案:

Traceback (most recent call last):
  File "pdoc", line 458, in <module>
    module = imp.load_source('__pdoc_file_module__', fp, f)
  File "C:\views\md_LDB_RegressionTests_v03.1_laptop\mts\Tests\LDB\Regression\Te
sts\tests\check_system_management\check_capabilities_encoding_problems.py", line
 4, in <module>
    from common.builders.system_request import default_create_system, create_cap
ability
ImportError: No module named common.builders.system_request


pdoc无法从回归中的其他模块导入函数...
我们项目的结构如下所示:

-Tests (C:\views\md_LDB_RegressionTests_v03.1_laptop\mts\Tests\LDB\Regression\Tests)
  -"common" package (with init file)
     -"builders" packege
        -system_request.py
  -"test" package
      -check_system_management package
         -check_capabilities_encoding_problems.py - this is the file i want to get documentation to


当然,还有很多其他软件包,但是我不确定现在描述所有结构是否有意义

check_capabilities_encoding_problems.py的导入部分如下所示:

import urllib
from hamcrest import assert_that, all_of
from proboscis import test, before_class, after_class
from common.builders.system_request import default_create_system, create_capability
from common.entity.LDBChecks import LDBChecks


我如何指向pdoc在哪里寻找其他模块的功能?
谢谢!

最佳答案

在Spyder IDE中使用pdoc时,我使用以下脚本将目录添加到pdoc路径

import pdoc
libpath = r'C:\Path\To\Module'
pdoc.import_path.append(libpath)
mod = pdoc.import_module('ModuleName')
doc = pdoc.Module(mod)
string = doc.html()


pdoc.import_path是用于查找模块的当前使用路径的列表。默认情况下,pdoc.import_path等于sys.path。可以在pdoc文档中找到更多信息。

08-24 16:23