回答情况：
提问时间：
问题标签：
所以我把python源文件放在两个不同的目录中：-~/work/myproject如何使用sphinx-apidoc递归地查看两个目录以生成显然，非常好，但是当我试图跑再说一遍，s
浏览 6修改于2020-04-10得票数 11
│ └── Test1.py └── Test2.py$ sphinx-apidoc如果我删除*它什么也找不到：
$ sphinx-apidoc -f -A "Author" -H "Test project" -V "version 1.0" -R "release 2014" -F
浏览 1提问于2014-09-05得票数 3
我通过sphinx-apidoc生成文档。文档被生成为默认的rst模板。如何使用自己的rst模板生成文档？
浏览 3修改于2020-10-05得票数 0
在用sphinx-apidoc.生成RST文件时，无法正确添加__main__.py文件及其函数其他文件和类是正确生成的。__main__.py看起来是这样的： """ """ f2()
main()
浏览 0修改于2020-10-07得票数 1
回答已采纳
:return tuple[str, str, str]: return my description 现在我将使用sphinx-apidoc然后运行sphinx-apidoc -o ./docs/_modules .**夏季：
，我已经用胡子定制了自动文档扩展，我需要sphinx-apidoc来正确地理解生成的文档字符串**。
浏览 13修改于2022-01-21得票数 1
我使用docstring来记录python代码，使用sphinx-autodoc来生成apidoc HTML。我的包的结构如下：mainpackage.subpackage.module，我希望apidocs链接到mainpackage.subpackage.Class模块中的类，而不是mainpackage.subpackage.module.Class。例如，我的问题来自于项目:我在skmultilearn.base.base中有一个MLClassifierBase类，但是我在skmultilearn.base中的__init__.py中导入它，我希望斯芬克斯生成的apidocs只使用这个
浏览 0修改于2016-06-26得票数 5
Travis build：https://travis-ci.com/Laurentiu-Andronache/he/jobs/184044676 conf.py：https://github.com/Laurentiu-Andronache/he/blob/master/docs/source/conf.py tox.ini：https://github.com/Laurentiu-Andronache/he/blob/master/tox.ini (查看testenv:doc8)
浏览 9修改于2019-03-12得票数 0
回答已采纳
sphinx支持选项-隐式名称空间来根据PEP420处理命名空间包。当我用"python setup.py build_sphinx“创建狮身人面像文档时，默认情况下，这并不适用于命名空间包。"python setup.py build_sphinx“和sphinx之间是否有关系(例如，在运行"python setup.py build_sphinx”时，sphinx是否在某个地方隐式调用？)如果是这样的话，我是否可以专门说明"python setup.py build_sphinx“应该考虑斯芬克斯-apidoc的隐式名称空间选项？
浏览 6提问于2017-06-26得票数 0
sys.path.insert(0, os.path.abspath('..'))然后，我做了一个动作：
sphinx-apidoc
浏览 4修改于2020-04-08得票数 16
回答已采纳
一旦所有设置就绪，Sphinx就已经安装好了，并且我在我的代码中添加了从我的项目根目录中输入的文档：输出：
Creating
浏览 7修改于2020-09-27得票数 2
回答已采纳
我想知道注释格式是什么，以便使用sphinx的sphinx实用程序实现自文档化代码。我能够让这个实用程序为每个python文件生成一组reStructuredText文件，但是这些文件仍然需要填充。我正在寻找一种获取此实用程序的方法，或者一些其他Sphinx实用程序，以从python代码docstring生成文档。我理解这将需要熟悉一种传统的评论格式，我希望能指出这一参考材料。谢谢!
浏览 3修改于2020-06-03得票数 3
回答已采纳
sphinx apidoc这样做的问题是它会生成错误的包，因为sphinx-apidoc使用子文件夹来生成
浏览 8修改于2021-02-05得票数 1
| | | | |-inference.py sphinx-apidoc
浏览 19提问于2019-08-28得票数 0
回答已采纳
1回答
[tox]basepython=python3.6deps=-r{toxinidir}/requirements/requirements.txt sphinx-apidoc --force -migration*'
pytest --maxfail=1 --tb=line -v --junit
浏览 2修改于2017-11-10得票数 2
有一个名为foo的包(最初处于高度开发阶段的API )，其rst文件由sphinx-apidoc自动生成。当发出新的sphinx-apidoc调用时，我如何才能不泄露所有这些信息呢？
浏览 0修改于2020-12-13得票数 3
回答已采纳
我知道下面的代码为所有模块生成rst，但不包括index.rst下面的代码生成所有内容，包括index.rst、conf.py、Makefile等问题是sphinx-apidoc不能生成正确的conf.py，所以我必须总是手动修改如果我在"very_good“文件夹中修改我的python代码，我应该运行不带"-
浏览 4修改于2020-10-06得票数 2
特别是，我希望在编写文档时使用sphinx-apidoc从代码中生成文档。一般来说，是否有任何准则来指导如何进行文档的构建？
浏览 5修改于2020-10-03得票数 6
回答已采纳
现在在folder A中，我这样做了
sphinx-apidoc -o .如果导入路径中没有根目录，如何使sphinx-apidoc生成配置文件？
浏览 6修改于2016-12-26得票数 0
回答已采纳
对于PEP3144( ipaddress模块)，我想使用sphinx-apidoc来生成初始参考文档。这意味着我想运行一个两遍操作：
使用sphinx-apidoc为依赖于autodoc的模块发出Sphinx项目运行创建新reStructuredText源文件的sphinx构建器，其中所有autodoc
浏览 60修改于2020-01-23得票数 22
回答已采纳
运行sphinx-apidoc后，命令C:\path\to\doc\make html将产生一个错误开始：
1-尝试运行sphinx_apidoc
'C:\path\to\jython\bin\sphinx-apidoc‘不被认为是内部或外部命令。2-使用Jython调用:带有合理选项的jython C:\path\to\jython\bin\sphinx-apidoc生成文档*.rst文件、conf.py等文件。看来，Sp
浏览 3修改于2014-02-03得票数 1
回答已采纳
腾讯云开发者
Copyright © 2013 - 2026 Tencent Cloud. All Rights Reserved. 腾讯云 版权所有
深圳市腾讯计算机系统有限公司 ICP备案/许可证号：粤B2-20090059 
粤公网安备44030502008569号
腾讯云计算（北京）有限责任公司 京ICP证150476号 | 京ICP备11018762号