我使用Sphinx autodoc扩展来记录我的Python项目。对于一个类，我的文档中有以下内容： :members: :show-inheritance:我正在记录的类有静态成员，我不想在文档中包含这些成员。
浏览 6提问于2017-07-20得票数 3
我正在使用NumPyDoc样式的文档字符串来记录一个Python包。我想从 Sphinx扩展切换到，因为我发现它以更紧凑和可读性更强的方式格式化了文档字符串。但是，它没有在文档的顶部列出类的方法，这是numpydoc的一个非常有价值的特性。有人知道如何在拿破仑中手动打开它吗？
浏览 18提问于2017-01-20得票数 10
1回答
我注意到狮身人面像呈现类描述的行为发生了变化。This is the body of the docstring description. var_int: int加上一些一般的狮身人面像设置，我大约两年前就得到了这个现在我得到了这个有没有办法告诉Sphinx不要将类变量添加到类定义的底部？尤其令人烦恼的是，它假设它们的值是None，仅仅因为它们没有默认值。
这个问题是在讨
浏览 6提问于2020-10-29得票数 2
回答已采纳
我使用sphinx和autodoc扩展从python模块中的docstring自动生成文档。 :members:有没有一种方法可以告诉automodule记录所有的公共成员，以及这一个私有成员？我尝试过使用:private-m
浏览 1提问于2019-01-31得票数 4
回答已采纳
1回答
最近，我通过项目的sphinx_autodoc_typehints开始使用狮身人面像的sphinx_autodoc_defaultargs扩展和。看起来，在readthedocs上的sphinx安装中并不是默认的包( sphinx在v1.8.5上)。因为我的构建失败了，Extension error显示了
Could not import extension sphinx<
浏览 11提问于2021-07-12得票数 2
2回答
在狮身人面像中，是否有一种方法可以获得自动模块指令来生成类中成员的TOC？。。private-members: :show-inheritance:它工作得很好，但是这个模块中有很多方法，指向该方法的toc
浏览 10提问于2015-02-03得票数 7
回答已采纳
我想使用狮身人面像记录一个大型项目，目前还没有很好的文档。特别是，我希望在编写文档时使用sphinx-apidoc从代码中生成文档。不过，我也想要一些关于如何使用项目等的教程，但似乎当我调用sphinx-apidoc时，它会立即生成整个文档。因此，我的问题是:这里的正确工作流是什么，这样我就可以编写要手动编写的教程页面，同时更新代码中的文
浏览 5提问于2014-02-28得票数 6
回答已采纳
我试图使用Sphinx1.4和sphinx-apidoc以及sphinx.ext.autodoc扩展为我的python类生成文档。我有很多模块，我希望每个模块只显示类名，而不是类中的完整方法列表(所有这些方法都在我的代码中有文档字符串)。，以防我需要在文档字符串中做一些我缺少的事情。所以我的问题是：
autodoc<
浏览 7提问于2016-04-02得票数 8
回答已采纳
1回答
我目前正在尝试使用Sphinx (使用sphinx-apidoc和napoleon扩展名)实现自动文档创建。这工作得很好，但如果类型提示(PEP484约定)自动添加到参数列表中，那就更好了。可以手动添加它们，但当决定更改签名时，这可能会带来未来的问题。手动添加类型的示例： ""&quo
浏览 41提问于2018-03-29得票数 10
回答已采纳
在视图函数中，我有关于REST urls的文档，我想为REST urls生成API文档。: list of genres { { "id":1, "name":"action" }, {...} } pass
但是当我在myproject.api.views上运行sphinx时，我得到了用python调用api的html文档。有没有办法将sphinx
浏览 0提问于2013-01-21得票数 0
回答已采纳
2回答
对于我的JavaScript框架，我想使用Sphinx。因为我是Sphinx世界的新手，所以我希望你们能帮助我开始使用Sphinx和JavaScript。
浏览 1提问于2011-12-27得票数 7
我正在尝试使用Sphinx来记录一个Python项目，但是我在将autodoc扩展与namedtuple生成的类组合在一起时遇到了问题。', # Most parameters omitted 'A0', ])
namedtuple生成的代码包括非常通用的文档字符串，Sphinx的autodoc模块提
浏览 0提问于2012-12-09得票数 12
回答已采纳
我在使用Sphinx为Flask应用程序生成文档时遇到了问题。不深入该应用程序的具体细节，其基本结构如下所示。Sphinx以及web服务所需的其他包，build文件夹位于docs子文件夹中，如下所示├── Makefile├── _static以确保Sphinx将忽略列
浏览 2提问于2017-06-22得票数 3
/docs文件夹中，我只有两个rst文件:一个带有一些介绍的index.rst和一个nix_shell_utils.rst文件，其中包成员自动从它们的文档字符串中描述：当使用make html在本地生成文档时，这个过程进行得很好:当单击index.html页面中<e
浏览 21提问于2022-11-06得票数 1
回答已采纳
3回答
当我构建文档时，我会得到一个警告WARNING: duplicate object description和在文档化后相同的空函数。例如：
如何删除这些别名？另外，我认为值得一提的是，在构建完之后，我得到了一张使用:noindex:的便条，但我不明白我应该在哪里使用它？在我的docstring，rst文件还是其他什么地方？
浏览 3提问于2020-05-03得票数 2
回答已采纳
2回答
我想用Sphinx编写文档的包包含纯Python模块(ok) +一个使用pybind11的C/C++库绑定。有许多依赖项不能合理地建立在ReadTheDocs上！因此，在RTD上，autodoc无法导入我的库来提取文档字符串.
我的第一个想法是在本地生成_build/doctrees并在RTD上使用它。但是它包含二进制文件，很难存储在存储库中:不行。是否有办法“扩展”RST文件中
浏览 12提问于2022-04-22得票数 1
2回答
Sphinx文档引擎能否成功生成导入不好的项目的文档？特别是，我的项目具有异国情调的依赖性。我不希望文档生成依赖于这种依赖关系。 Sphinx需要导入我的模块并使用内省，还是需要进行解析？
浏览 0提问于2013-06-28得票数 3
我正在做几个使用Java编写的库的Jython项目。多亏了autodoc扩展，我想用Sphinx创建一些好的文档。然而，当我尝试创建html时，我得到了错误，因为autodoc找不到用Java编写的库：Running Sphinx v1.0.5
loading pick
浏览 2提问于2011-02-08得票数 7
回答已采纳
我有一个Python项目，使用Sphinx作为文档。我正在readthedocs.io服务上远程构建文档。sphinx-autodoc还为我的项目中的每个包生成了文件，它们包含如下指令：-------------------------
"sphinx.e
浏览 2提问于2020-11-05得票数 0
回答已采纳
扫码
添加站长 进交流群
领取专属 10元无门槛券
手把手带您无忧上云
相关资讯
热门标签
云服务器
ICP备案
对象存储
腾讯会议
云直播活动推荐
腾讯云开发者
