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

发布于 2024-12-04 04:41:14 字数 174 浏览 0 评论 0原文

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

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

这可能吗?如果可能的话,如何实现?

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?

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(2

独孤求败 2024-12-11 04:41:14

我遇到了同样的问题,并遇到了这个问题试图弄清楚。我也不知道该怎么做,所以这就是我的解决方案。我只是在当前目录中生成文档并将文件移动到我想要的位置,而不是尝试欺骗 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

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

I had the same issue and came across this question trying to figure it out. I couldn't figure out how to do it either, so this is my solution. Rather than try to trick pydoc to outputting to a specific location, I'm just generating the documentation in the current directory and moving the files to the location I want.

In my case, the target folder is named 'doc', and the source is located under the 'semlm' directory

mkdir -p doc
pydoc -w `find semlm -name '*.py'`
mv *.html doc

(You should be able to customize the pydoc command as you wish, but this is what worked for me).

I didn't want to type this all out every time so I put it in a Makefile. Here is an excerpt:

.PHONY: doc

doc:
    mkdir -p doc
    pydoc -w `find semlm -name '*.py'`
    mv *.html doc

The .PHONY: doc is needed because the Makefile target has the same name as a folder in the top level directory (i.e. 'doc'). Now I can generate documentation into the doc folder by running:

make doc

Perhaps there is a more elegant way, but this is the best I've found so far.

情丝乱 2024-12-11 04:41:14

pydoc -w ...

将模块的 HTML 文档写出到当前目录中的文件中
目录。如果包含“/”,则将其视为文件名;如果
它命名一个目录,为所有内容编写文档。

pydoc -w ...

Write out the HTML documentation for a module to a file in the current
directory. If contains a '/', it is treated as a filename; if
it names a directory, documentation is written for all the contents.

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文