如何在不编写一行文档字符串的情况下生成文档?我只是想要一个api参考页面

问题描述 投票:0回答:0

同上

因为我认为,如果函数中有类型注释,那么我们就不需要docstring来描述它。

比如我的一个源码函数:

    def sort_files_by_time(self, files: List[str], reverse: bool = False):
        files.sort(key=os.path.getmtime, reverse=reverse)
        return files

我希望它能生成一个 html 格式的 api 文档。就像我在 vscode 函数提示中看到的一样

python sphinx
© www.soinside.com 2019 - 2024. All rights reserved.