PyDoc在生成模块文档时在当前目录中创建HTML文档。 我真的需要指定另一个目录,它将是生成文档的占位符,而不是调用PyDoc的目录。
我正在使用python -m pydoc -w <MODULES_DIR>
生成文档。
这是可能的,如果可能,怎么样?
答案 0 :(得分:4)
我遇到了同样的问题,并试图弄清楚这个问题。我也无法弄清楚如何做到这一点,所以这是我的解决方案。我没有尝试欺骗pydoc输出到特定位置,而只是在当前目录中生成文档并将文件移动到我想要的位置。
在我的情况下,目标文件夹名为&#39; doc&#39;,源位于&#39; semlm&#39;目录
mkdir -p doc
pydoc -w `find semlm -name '*.py'`
mv *.html doc
(您应该可以根据需要自定义pydoc命令,但这对我有用)。
我不想每次都输入这个,所以我把它放在Makefile中。这是一段摘录:
.PHONY: doc
doc:
mkdir -p doc
pydoc -w `find semlm -name '*.py'`
mv *.html doc
需要.PHONY: doc
,因为Makefile目标与顶级目录中的文件夹同名(即&#39; doc&#39;)。现在我可以通过运行:
make doc
也许有一种更优雅的方式,但这是迄今为止我发现的最好的方式。
答案 1 :(得分:3)
pydoc -w ...
将模块的HTML文档写入当前文件 目录。如果包含'/',则将其视为文件名;如果 它命名一个目录,为所有内容编写文档。