python⽣成api⽂档_如何在PyCharm中⾃动⽣成PythonAPI⽂
档
python中文文档
我也简单地发现了这个问题：
My question is this: Can I use the DocUtils or Sphinx features of PyCharm to generate the API documentation?
不.但是，您可以使⽤PyCharm快速查看⽂档ctrl Q，它将使⽤链接，表格等进⾏格式化.
Failing that, can I use any features of PyCharm to do this?
事实并⾮如此,PyCharm只能为函数和⽅法插⼊⽂档存根，但它⽆法执⾏api发现来⾃动注释它⽆法创建第⼀个⽂档存根的所有内容.
Failing that, are there any tools to do this that integrate well with PyCharm?
是:) sphinx-apidoc这是⼀个可以⾃动从代码中创建第⼀个⽂档的⼯具.还有⼀些鲜为⼈知的autoapi
你只需指向根⽬录，瞧它甚⾄可以包含没有doc字符串的成员.它实际上只是使⽤⾃动模块语法创建⼀个
简单的第⼀个⽂档.之后你可以从PyCharm运⾏sphinx任务，你有⼀个代码⽂档，你甚⾄可以使⽤像sphinx_rtd_theme这样的主题使它看起来⾮常好.
例：
sphinx-apidoc -o source / ../
假设您在项⽬中创建了⼀个doc⽂件夹，然后使⽤cd doc并使⽤sphinx-quickstart上⾯的命令进⼊⽗⽬录以发现任何源⽂件并记录它们.结果存储在< project> / doc / source⽂件夹中.在其他⽂件中，将有⼀个modules.rst将所有⾃动⽣成的⽂件拉到⼀起.
然后在index.rst中添加⼀⾏.. toctree :: … 源极/模块

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。