python - 如何告诉 PyDoc 生成文档到用户定义的目录

Question

PyDoc 在生成模块文档时在当前目录中创建 HTML 文档。我确实需要指定另一个目录，该目录将作为生成文档的占位符，而不是调用 PyDoc 的目录。

我正在使用 python -m pydoc -w <MODULES_DIR>生成文档。

这是否可能，如果可能，如何实现？

Answer 1

我遇到了同样的问题，并在试图弄清楚这个问题时遇到了这个问题。我也不知道该怎么做，所以这是我的解决方案。我只是在当前目录中生成文档并将文件移动到我想要的位置，而不是试图欺骗 pydoc 输出到特定位置。

在我的例子中，目标文件夹名为“doc”，源位于“semlm”目录下

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 目标与顶级目录中的文件夹同名(即“doc”)。现在我可以通过运行将文档生成到 doc 文件夹中:

make doc

也许有更优雅的方式，但这是目前为止我发现的最好的方式。