我正在使用PyCharm开发Python项目，现在需要生成相应的API文档。我正在使用docstrings记录代码方法和类。我了解了Sphinx和Doxygen，目前Sphinx是最受推荐的。我尝试在PyCharm中配置Sphinx，但无法使其正常工作。 这是项目结构： 这是与命令Sp...

我正在开发一个只有一个 .py 模块的 Python 库，并尝试从文档字符串生成文档。我已经安装了 Sphinx 并运行了 spinx-quickstart 脚本，但当我尝试在文档目录下运行以下命令时： sphinx-apidoc ../cffiwrap.py -o . 但是它只是说： ...

目前，每当我运行sphinx-build时，只有源文件发生更改才会捕获和使用内联文档字符串。我尝试使用-a开关调用sphinx-build，但似乎没有效果。 我该如何强制重新构建HTML输出并强制执行自动文档执行？

我有这样的项目结构：package/ __init__.py module.py __init__.py 包含：from .module import Class module.py 包含：class Class: pass 使用 sphinx-apidoc -o pa...

我正在尝试记录一个Python包。目前，我的目录结构如下：. └── project ├── _build │   ├── doctrees │   └── html │   ├── _sources │   └── _static ...

以前有一些帖子谈论过这个话题，声称Sphinx根本不支持这个。我有些怀疑，但它可能已经更新了，或者文档被很好地隐藏起来了，因为这里有一个链接表明了相反的情况: http://www.sphinx-doc.org/en/master/usage/restructuredtext/domains....

我目前正在尝试使用Sphinx（使用扩展程序sphinx-apidoc和napoleon）实现自动文档创建。这个方法非常有效，但如果能够自动添加参数列表中的类型提示（PEP484约定），那就更好了。 我想知道这是否可能。 更具体地说： （来自napoleon示例）def function_...

所以我的Python源文件分别位于两个不同的目录中： 例如：~/work/myproject ~/.virtualenvs/myproject 我该如何使用sphinx-apidoc来递归查找两个目录以生成我的reST文件？显然，sphinx-apidoc -o docs/source ~/w...

我正在尝试在真正的项目之前为测试Python项目创建文档。我的系统：Win7 64位，Python 2.7.5 64位。我的项目名称是testDoc。它包括一个名为t的Python包，其中包括2个模块t1和t2以及__init__.py。__init__.py包含： import t1 im...

我有一个Python文件(lib.py)，里面有一些没有类的函数。每个函数都具有以下风格：def fnc1(a,b,c): ''' This fonction does something. :param a: lalala :type a: str ...