- android - 多次调用 OnPrimaryClipChangedListener
- android - 无法更新 RecyclerView 中的 TextView 字段
- android.database.CursorIndexOutOfBoundsException : Index 0 requested, 光标大小为 0
- android - 使用 AppCompat 时,我们是否需要明确指定其 UI 组件(Spinner、EditText)颜色
再见,我在自动生成 python 文档时遇到了问题。我的项目布局如下:
项目文件夹
在 module1.py 和 module2.py 中有一些类(带有文档字符串)。我在 conf.py 中添加了以下行:
sys.path.insert(0, os.path.abspath('../../package'))
modules.rst 和 package.rst 都是通过调用生成的:
sphinx-apidoc -o doc/source package/
文件夹内。最后,我在 index.rst 文件中添加了“模块”,如下所示(不是整个 index.rst,但它是由 sphinx-quickstart 生成的):
Contents:
.. toctree::
:maxdepth: 2
modules
我有几个问题:
1) 当我从 doc/目录调用 sphinx-autodoc 时,文档没有生成。为了正确生成文档,我必须在 package.rst 中用 module1 替换 package.module1:
#before
.. automodule:: package.module1
:members:
:undoc-members:
:show-inheritance:
#after
.. automodule:: module1
:members:
:undoc-members:
:show-inheritance:
如何自动执行此操作?还是我的设置有问题?
2) 如果 module1.py 只包含一堆 def,则文档生成正确。但是,如果我只在其中放置一个类,则根本不会生成文档(请注意,即使在第二次运行 sphinx-apidoc 后,package.rst 文件仍保持不变)。如何显示类文档?
谢谢
最佳答案
好的,在查看了 sphinx 日志之后(我很遗憾没有将它们发布出来)我意识到了第一个问题的答案:如果你想使用 sphinx-apidoc 输出,你必须在 conf.py 中添加“包”的父级"包,不是包本身
sys.path.insert(0, os.path.abspath('../../')) #documentation is detected
sys.path.insert(0, os.path.abspath('../../package')) #documentation isn't detected
这样python就导入了PYTHONPATH中的文件夹,从而解决了“Package.module1”/“Package.module2”路径。至于问题 #2,我意识到(再次,我的坏)sphinx 只为公共(public)成员生成文档,而我的类(class)只有 dunder 方法(如 __ init__)。如果您想记录这些方法(像我一样),请务必在加载的模块下的 .rst 文件中添加:special-members:
.. automodule:: Package.module2
:members:
:undoc-members:
:show-inheritance:
:private-members: # if you want to document __x attributes
:special-members: # if you want to document __xxx__ dunder methods
关于python - Sphinx 不处理 python 类,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/31479835/
对于 Metal ,如果对主纹理进行 mipmap 处理,是否还需要对多采样纹理进行 mipmap 处理?我阅读了苹果文档,但没有得到任何相关信息。 最佳答案 Mipmapping 适用于您将从中
我正在使用的代码在后端 Groovy 代码中具有呈现 GSP(Groovy 服务器页面)的 Controller 。对于前端,我们使用 React-router v4 来处理路由。我遇到的问题是,通过
我们正在 build 一个巨大的网站。我们正在考虑是在服务器端(ASP .Net)还是在客户端进行 HTML 处理。 例如,我们有 HTML 文件,其作用类似于用于生成选项卡的模板。服务器端获取 HT
我正在尝试将图像加载到 void setup() 中的数组中,但是当我这样做时出现此错误:“类型不匹配,'processing .core.PImage' does not匹配“processing.
我正在尝试使用其私有(private)应用程序更新 Shopify 上的客户标签。我用 postman 尝试过,一切正常,但通过 AJAX,它带我成功回调而不是错误,但成功后我得到了身份验证链接,而不
如何更改我的 Processing appIconTest.exe 导出的默认图标在窗口中的应用程序? 默认一个: 最佳答案 经过一些研究,我能找到的最简单的解决方案是: 进入 ...\process
我在 Processing 中做了一个简单的小游戏,但需要一些帮助。我有一个 mp3,想将它添加到我的应用程序中,以便在后台循环运行。 这可能吗?非常感谢。 最佳答案 您可以使用声音库。处理已经自带
我有几个这样创建的按钮: 在 setup() PImage[] imgs1 = {loadImage("AREA1_1.png"),loadImage("AREA1_2.png"),loadImage
我正在尝试使用 Processing 创建一个多人游戏,但无法弄清楚如何将屏幕分成两个以显示玩家的不同情况? 就像在 c# 中一样,我们有Viewport leftViewport,rightView
我一直在尝试使用 Moore 邻域在处理过程中创建元胞自动机,到目前为止非常成功。我已经设法使基本系统正常工作,现在我希望通过添加不同的功能来使用它。现在,我检查细胞是否存活。如果是,我使用 fill
有没有办法用 JavaScript 代码检查资源使用情况?我可以检查脚本的 RAM 使用情况和 CPU 使用情况吗? 由于做某事有多种方法,我可能会使用不同的方法编写代码,并将其保存为两个不同的文件,
我想弄清楚如何处理这样的列表: [ [[4,6,7], [1,2,4,6]] , [[10,4,2,4], [1]] ] 这是一个整数列表的列表 我希望我的函数将此列表作为输入并返回列表中没有重复的整
有没有办法在不需要时处理 MethodChannel/EventChannel ?我问是因为我想为对象创建多个方法/事件 channel 。 例子: class Call { ... fields
我有一个关于在 Python3 中处理 ConnectionResetError 的问题。这通常发生在我使用 urllib.request.Request 函数时。我想知道如果我们遇到这样的错误是否可
我一直在努力解决这个问题几个小时,但无济于事。代码很简单,一个弹跳球(粒子)。将粒子的速度初始化为 (0, 0) 将使其保持上下弹跳。将粒子的初始化速度更改为 (0, 0.01) 或任何十进制浮点数都
我把自己弄得一团糟。 我想在我的系统中添加 python3.6 所以我决定在我的 Ubuntu 19.10 中卸载现有的。但是现在每次我想安装一些东西我都会得到这样的错误: dpkg: error w
我正在努力解决 Rpart 包中的 NA 功能。我得到了以下数据框(下面的代码) Outcome VarA VarB 1 1 1 0 2 1 1 1
我将 Java 与 JSF 一起使用,这是 Glassfish 3 容器。 在我的 Web 应用程序中,我试图实现一个文件(图像)管理系统。 我有一个 config.properties我从中读取上传
所以我一直在Processing工作几个星期以来,虽然我没有编程经验,但我已经转向更复杂的项目。我正在编写一个进化模拟器,它会产生具有随机属性的生物。 最终,我将添加复制,但现在这些生物只是在屏幕上漂
有人知道 Delphi 2009 对“with”的处理有什么不同吗? 我昨天解决了一个问题,只是将“with”解构为完整引用,如“with Datamodule、Dataset、MainForm”。
我是一名优秀的程序员,十分优秀!