pydoc能生成子目录吗?
有没有办法让pydoc的writedocs()函数为包创建子目录?比如说,我有以下这些模块需要文档:
foo.py
dir/bar.py
dir/__init__.py
当我运行pydoc.writedocs()时,我得到以下文件:
foo.html
dir.bar.html
我希望得到的是:
foo.html
dir/bar.html
有没有办法做到这一点?
1 个回答
1
pydoc.writedocs
这个函数其实就是在不停地调用 writedoc
,而 writedoc
的功能是“在当前目录下写一个文件”。我能想到的唯一解决办法就是自己修改这个函数,然后把它强行放进模块里,或者修改它的一些关键部分,比如它用来打开写入 HTML 文件的那个地方。具体来说,在你的代码里,你可以这样做:
import pydoc
def monkey_open(name, option):
if option == 'w' and name.endswith('.html'):
name_pieces = name.split('.')
name_pieces[-2:] = '.'.join(name_pieces[-2:])
name = '/'.join(name_pieces)
return open(name, option)
pydoc.open = monkey_open
这并不是一个优雅或者特别稳健的解决方案,但“需要就得这样做”... 因为 pydoc 本身并不是为了让你实现你想要的功能而设计的,所以我们得稍微“强行塞进去”一点。