python-sphinx

71热度

3回答

如何使用Sphinx的autodoc来记录类的__init __（self）方法？

默认情况下，Sphinx不会为__init __（self）生成文档。我曾尝试以下： .. automodule:: mymodule :members: 和 ..autoclass:: MyClass :members: 在conf.py，设置以下仅追加__init __（个体经营）文档字符串类的文档字符串（the Sphinx autodoc documentati

3热度

1回答

狮身人面像，buildbot（和代码覆盖率）。他们如何整合？

我有一个不是很小的python包，有很多历史记录，都有docstrings。在开发过程中，我们引入了buildbot以及后来的Jenkins/Hudson。最近，我为buildbot.cfg添加了sphinx配方，以便收集来源的文档并保持最新的可访问文档。到目前为止，这么好：我每次提交更改时，Jenkins会全面检查软件包，生成非常完整的概览并更新我们的文档网站。我启用的一个狮身人面像扩展：c

0热度

1回答

sphinx autodoc help

试图使用sphinx的autdoc扩展，但它不工作。我在djano项目文件夹中保存了“docs”文件夹。它没有为我的模块生成文档。另外我不确定自动待办事项是如何工作的。

49热度

4回答

在reStructuredText链接中设置文本格式

如何设置reStructuredText中指定链接的文本格式？具体来说，我想从我的第一个生成以下HTML： <a href="http://docs.python.org/library/optparse.html"><tt>optparse.OptionParser</tt> documentation documentation</a> 结果应该是这样的： optparse.Option

6热度

3回答

如何从python生成reST/sphinx源代码？

我想通过reST生成文档，但不想手动编写reST源代码，但让python脚本执行该操作，然后使用sphinx生成其他格式（HTML，PDF）。想象一下，我有一个二进制格式的电话簿。现在我用一个python脚本解析这个并产生所有的名字和号码的文档： phone_book = PhonebookParser("somefile.bin") restdoc = restProducer.N

10热度

1回答

是否有可能重写特定功能的狮身人面像autodoc？

我正在使用Sphinx的autodoc插件来自动记录一组模块。我有一个接受*args的函数，我想覆盖文档以显示Python stdlib文档使用的略微好看的funcname(arg1[, arg2[, ...]])样式。是否有可能覆盖特定功能的autodoc输出？

18热度

1回答

sphinx自定义的latexpdf输出？

只是好奇，如果有人知道如何定制使用latexpdf目标时的狮身人面像输出？我已经看到很多html输出的自定义东西，但似乎找不到任何自定义PDF输出的例子。具体来说，我有兴趣定制标题页，页眉，页脚，并可能在内容前添加前几页的内容。有没有人看到过这种定制的任何例子，或者几乎所有人在生成pdf时都使用“stock”狮身人面像输出？谢谢！

32热度

1回答

Sphinx文档：从生成的PDF中删除空白页面？

默认情况下，Sphinx文档输出格式化为双面打印的PDF。因此，在标题页面和目录，TOC和介绍，介绍和第一部分之间有一个空白页面。我的用户总是会在线查看PDF。所以我想删除这些空白页面。这似乎是狮身人面像中一个棘手的问题。 See this email thread。 This user提出了两种解决方案，但都不适用于我。奇怪的是，第一个解决方案： latex_elements = {

1热度

1回答

同时使用多个狮身人面像主题

我想在狮身人面像中使用多个主题 - 这样一个页面有一个主题，第二个页面有第二个主题。在我看来，只能同时设定一个主题 - 这是真的吗？非常感谢，斯内德

59热度

2回答

如何在reStructuredText中创建嵌套列表？

我试图创建使用下面的代码正确嵌套表（以下Sphinx和docutils文档）： 1. X a. U b. V c. W 2. Y 3. Z 我预计这将导致两个OL秒，但我得到以下输出，而不是： <ol class="arabic simple"> <li>X</li> </ol> <blockquote> <div> <