PyCharm 使用以下文档生成器帮助生成格式化的 API 文档:
请注意以下几点:
文档生成器应正确安装在您的机器上。有关详细信息,请参阅各自的下载和安装页面。
PyCharm 识别文档字符串格式并使用设置对话框的Python 集成工具页面中定义的文档源目录。
选择DocUtil任务运行/调试配置,根据需要进行修改:指定配置名称、输入输出目录、可选键。
启动此运行/调试配置,如运行和重新运行应用程序部分所述。
确保 Sphinx 包已与 Python 解释器一起安装(安装、卸载和升级包。
| | )。有关如何在 PyCharm 中安装包的更多信息,请参阅从主菜单中,选择
。如果Python Integrated Tools页面中未指定Sphinx 工作目录,则会打开“设置工作目录”对话框,建议指定文档的路径。
在 PyCharm 中打开的控制台中,回答sphinx-quickstart实用程序提供的问题。特别是,指定源目录,生成的conf.py文件将存储在其中。如果在回答这个问题时,您只需按下Enter,PyCharm 将使用您在上一步中指定的路径,或者在Python 集成工具页面的Sphinx 工作目录字段中指定的路径。
以下列方式之一打开“运行/调试配置”对话框:
选择
从主菜单在导航栏可见的情况下( ),从运行/调试配置选择器中选择
按Alt+Shift+F10,然后按0。
在“运行/调试配置”对话框中,单击工具栏上的 或按Alt+Insert。该列表显示运行/调试配置模板。
选择Sphinx任务运行/调试配置,根据需要更改:指定配置名称、输入输出目录。
启动此运行/调试配置,如运行和重新运行应用程序部分所述。