当我运行 sphinx-apidoc 然后 make html 时，它会生成包含“Subpackages”和“Submodules”部分以及“module”和“package”的文档页面目录 (TOC) 中每个模块/包名称的末尾。如何在不编辑 Sphinx 源代码的情况下防止编写这些额外的标题？
这是我想制作的示例文档页面(注意目录):
http://selenium.googlecode.com/svn/trunk/docs/api/py/index.html#documentation
我理解这是由于 sphinx 源中的 apidoc.py 文件(第 88 行):
我可以手动编辑每个单独的 .rst 文件以删除这些标题或只是从脚本中删除这些代码行，但随后我必须编译 Sphinx 源代码。是否有一种无需手动编辑 Sphinx 源代码即可自动执行此操作的方法？
最佳答案
当我发现这个问题时，我自己也在努力解决这个问题……给出的答案并没有完全满足我的要求，所以我发誓要在弄清楚后回来。 :)
为了从自动生成的标题中删除“包”和“模块”并拥有真正自动的文档，您需要在几个地方进行更改，请耐心等待。 p>
首先，您需要处理您的sphinx-apidoc 选项。我使用的是:
sphinx-apidoc -fMeET ../yourpackage -o api
假设您从 docs 目录中运行它，这将获取 yourpackage 的文档并将生成的文件放在 docs/api .我在这里使用的选项将覆盖现有文件，将模块文档放在子模块文档之前，将每个模块的文档放在其自己的页面上，如果您的文档字符串已经有它们，则放弃创建模块/包标题，并且它不会创建目录文件。
有很多选项需要记住，所以我只是将其添加到我的 Makefile 的末尾:
buildapi:
sphinx-apidoc -fMeET ../yourpackage -o api
@echo "Auto-generation of API documentation finished. " \
"The generated files are in 'api/'"
有了这个，您可以运行 make buildapi 来构建您的文档。
接下来，在您的文档的根目录下创建一个 api.rst 文件，内容如下:
API Documentation
=================
Information on specific functions, classes, and methods.
.. toctree::
:glob:
api/*
这将创建一个目录，其中包含 api 文件夹中的所有内容。
不幸的是，sphinx-apidoc 仍会生成一个带有难看的“yourpackage package”标题的yourpackage.rst 文件，因此我们需要最后一项配置。在您的 conf.py 文件中，找到 exclude_patterns 选项并将此文件添加到列表中。它应该看起来像这样:
exclude_patterns = ['_build', 'api/yourpackage.rst']
现在您的文档应该看起来与您在模块文档字符串中设计的完全一样，您永远不必担心您的 Sphinx 文档和代码内文档不同步!
关于python - Python 模块/包名称的 Sphinx apidoc 部分标题，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/21003122/
假设我做了一个模块如下:m=Module.newdoclassCendend三个问题:除了对m的引用之外，还有什么方法可以访问C和m中的其他内容？我可以在创建匿名模块后为其命名吗(就像我输入“module...”一样)？如何在使用完匿名模块后将其删除，使其定义的常量不再存在？ 最佳答案 三个答案:是的，使用ObjectSpace.此代码使c引用你的类(class)C不引用m:c=nilObjectSpace.each_object{|obj|c=objif(Class===objandobj.name=~/::C$/)}当然这取决于
作为我的Rails应用程序的一部分，我编写了一个小导入程序，它从我们的LDAP系统中吸取数据并将其塞入一个用户表中。不幸的是，与LDAP相关的代码在遍历我们的32K用户时泄漏了大量内存，我一直无法弄清楚如何解决这个问题。这个问题似乎在某种程度上与LDAP库有关，因为当我删除对LDAP内容的调用时，内存使用情况会很好地稳定下来。此外，不断增加的对象是Net::BER::BerIdentifiedString和Net::BER::BerIdentifiedArray，它们都是LDAP库的一部分。当我运行导入时，内存使用量最终达到超过1GB的峰值。如果问题存在，我需要找到一些方法来更正我的代
关闭。这个问题是opinion-based.它目前不接受答案。想要改进这个问题？更新问题，以便editingthispost可以用事实和引用来回答它.关闭4年前。Improvethisquestion我想在固定时间创建一系列低音和高音调的哔哔声。例如:在150毫秒时发出高音调的蜂鸣声在151毫秒时发出低音调的蜂鸣声200毫秒时发出低音调的蜂鸣声250毫秒的高音调蜂鸣声有没有办法在Ruby或Python中做到这一点？我真的不在乎输出编码是什么(.wav、.mp3、.ogg等等)，但我确实想创建一个输出文件。
我有一个包含模块的模型。我想在模块中覆盖模型的访问器方法。例如:classBlah这显然行不通。有什么想法可以实现吗？ 最佳答案 您的代码看起来是正确的。我们正在毫无困难地使用这个确切的模式。如果我没记错的话，Rails使用#method_missing作为属性setter，因此您的模块将优先，阻止ActiveRecord的setter。如果您正在使用ActiveSupport::Concern(参见thisblogpost)，那么您的实例方法需要进入一个特殊的模块:classBlah
我有一张背景图片，我想在其中添加一个文本框。我想弄清楚如何将标题放置在其顶部的正确位置。(我使用标题是因为我需要自动换行功能)。现在，我只能让文本显示在左上角，但我需要能够手动定位它的开始位置。require'RMagick'require'Pry'includeMagicktext="Loremipsumdolorsitamet"img=ImageList.new('template001.jpg')img 最佳答案 这是使用convert的ImageMagick命令行的答案。如果你想在Rmagick中使用这个方法，你必须自己移植
我刚刚被困在这个问题上一段时间了。以这个基地为例:moduleTopclassTestendmoduleFooendend稍后，我可以通过这样做在Foo中定义扩展Test的类:moduleTopmoduleFooclassSomeTest但是，如果我尝试通过使用::指定模块来最小化缩进:moduleTop::FooclassFailure这失败了:NameError:uninitializedconstantTop::Foo::Test这是一个错误，还是仅仅是Ruby解析变量名的方式的逻辑结果？ 最佳答案 Isthisabug,or
我想获取模块中定义的所有常量的值:moduleLettersA='apple'.freezeB='boy'.freezeendconstants给了我常量的名字:Letters.constants(false)#=>[:A,:B]如何获取它们的值的数组，即["apple","boy"]？ 最佳答案 为了做到这一点，请使用mapLetters.constants(false).map&Letters.method(:const_get)这将返回["a","b"]第二种方式:Letters.constants(false).map{|c
我的假设是moduleAmoduleBendend和moduleA::Bend是一样的。我能够从thisblog找到解决方案,thisSOthread和andthisSOthread.为什么以及什么时候应该更喜欢紧凑语法A::B而不是另一个，因为它显然有一个缺点？我有一种直觉，它可能与性能有关，因为在更多命名空间中查找常量需要更多计算。但是我无法通过对普通类进行基准测试来验证这一点。 最佳答案 这两种写作方法经常被混淆。首先要说的是，据我所知，没有可衡量的性能差异。(在下面的书面示例中不断查找)最明显的区别，可能也是最著名的，是你的
我一直致力于让我们的Rails2.3.8应用程序在JRuby下正确运行。一切正常，直到我启用config.threadsafe!以实现JRuby提供的并发性。这导致lib/中的模块和类不再自动加载。使用config.threadsafe!启用:$rubyscript/runner-eproduction'pSim::Sim200Provisioner'/Users/amchale/.rvm/gems/jruby-1.5.1@web-services/gems/activesupport-2.3.8/lib/active_support/dependencies.rb:105:in`co
这个问题在这里已经有了答案:关闭10年前。PossibleDuplicate:Pythonconditionalassignmentoperator对于这样一个简单的问题表示歉意，但是谷歌搜索||=并不是很有帮助；)Python中是否有与Ruby和Perl中的||=语句等效的语句？例如:foo="hey"foo||="what"#assignfooifit'sundefined#fooisstill"hey"bar||="yeah"#baris"yeah"另外，类似这样的东西的通用术语是什么？条件分配是我的第一个猜测，但Wikipediapage跟我想的不太一样。