我试图用Python记录一个包.目前我有以下目录结构:
.
??? project
??? _build
? ??? doctrees
? ??? html
? ??? _sources
? ??? _static
??? conf.py
??? index.rst
??? __init__.py
??? make.bat
??? Makefile
??? mod1
? ??? foo.py
? ??? __init__.py
??? mod2
? ??? bar.py
? ??? __init__.py
??? _static
??? _templates
这棵树是射击的结果sphinx-quickstart.在conf.py我没有注释sys.path.insert(0, os.path.abspath('.')),我有extensions = ['sphinx.ext.autodoc'].
我index.rst是:
.. FooBar documentation master file, created by
sphinx-quickstart on Thu Aug 28 14:22:57 2014.
You can adapt …我在PyCharm中有一个Python项目,我想从我的Python代码和文档字符串中自动生成API文档(以HTML的形式).
根据此页面,有许多工具可以生成Python API文档:
该页面还注意到以下工具"流程文档":
该PyCharm文件说的是docutils的狮身人面像和可以使用"产生格式化的API文档".但是,这似乎是不正确的,因为它们的配置表明这些工具只处理*.rst文件,而不处理*.py文件.
我的问题是:我可以使用PyCharm的DocUtils或Sphinx功能来生成API文档吗？
如果做不到这一点,我可以使用PyCharm的任何功能来做到这一点吗？
如果不这样做,有没有任何工具可以与PyCharm很好地集成？