python - How to tell PyDoc to generate documentation to user defined directory

Question

PyDoc creates HTML documentation in current directory when generating documentation of modules. I really need to specify another directory which will be a placeholder for generated documentation instead the directory from which PyDoc is called.

I am using python -m pydoc -w <MODULES_DIR> to generate documentation.

Is this possible and if it is, how?

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

也许有一种更优雅的方式，但这是迄今为止我发现的最好的方式。

Answer 2

pydoc -w ...

将模块的 HTML 文档写入当前目录中的文件。如果包含'/'，则将其视为文件名；如果它命名一个目录，则为所有内容编写文档。