python-sphinx

2热度

1回答

我使用Sphinx来记录Python模块。我有一个主目录doc，我在其中将个别*.rst文件（对于每个模块组件）都包含在index.rst主文件中。这很好（请检查source of the Python Library Reference，看看我是如何做到的）。我的问题是当我需要为给定的模块组件（而不是整个模块）创建一个独立的PDF。假设您具有与完整模块（库）中的Python Library

3热度

4回答

我该如何摆脱狮身人面像乳胶输出的页眉中的“第1版”？

我正在使用Sphinx的“手动”文档类，我很满意乳胶输出如何，除了页眉。它包含我的论文的标题以及“第1版”。因为我正在写一篇文章而不是文档，所以我显然不需要发布信息。不幸的是，很难找到关于如何定制Sphinx胶乳输出的信息。有人知道该怎么做吗？

3热度

3回答

Django templatetags上的狮身人面像文档

我使用Sphinx和autodoc来记录我的Django项目。设计人员想要拥有关于项目中定义的所有模板标签的文档页面。当然，我可以通过手工列举所有模板处理函数来制作这样的页面，但我认为它不是干的，不是吗？实际上，模板标签处理函数全部用@register.inclusion_tag装饰器标记。因此，对于一些例行程序来说，将它们全部收集并放入文档似乎是可能的和自然的。与过滤功能相同。我已经使用它

4热度

4回答

sphinx.ext.pngmath当我尝试一个简单的表达时产生一个错误

我使用Sphinx来创建我的项目的文档。我想使用扩展sphinx.ext.pngmath和与这个小测试： Returns the indefinite integral of the polynomial *poly*: .. math:: \int p(x)dx 我得到了错误： WARNING: inline latex u'\\int p(x)dx\n\n': lat

10热度

1回答

在我的Sphinx文档中包含PDF的最佳方式是什么？

我有一个PDF格式的文件，它有一些我深入解释的Sphinx文档中的例子。有没有办法轻松地将PDF包含在我的项目中（并在构建文档时将其复制）？我试着用：doc连接到它：但是这并没有复制它。

22热度

5回答

Python狮身人面像autodoc和装饰成员

我试图使用狮身人面像来记录我的Python类。我可能会使用车博士： .. autoclass:: Bus :members: 虽然正确地读取了我的方法的文档字符串，那些装饰： @checkStale def open(self): """ Some docs. """ # Code 与@checkStale是 def ch

16热度

3回答

sphinx，restructuredtext：为单个单词设置颜色

有没有办法设置sphinx中的单个单词（或字符）的颜色？我很确定应该有一些标记标记，比如HTML的font标记。

2热度

1回答

html中的双向性

使用Sphinx，我在编辑pylearn文档内容https://bitbucket.org/omidraha/pylearn/。所有段落都是从右到左（由于波斯语言）以及文本之间的代码示例，渲染不正确。通常我正在寻找一种方法来在网页上应用unicode或microsoft的双向性算法。有没有办法将css样式的代码设置为RTL段落内的LTR？如果没有，我怎么能修改狮身人面像源来做单独的代码示例，

27热度

2回答

将Sphinx autodoc-skip-member连接到我的函数

我想使用sphinx's autodoc-skip-member事件来选择某个python类的成员的一部分作为文档。但是从狮身人面像文档中并不清楚，我找不到任何示例说明：我在哪里将代码连接到此？我看到Sphinx.connect，我怀疑它会在我的conf.py，但是当我尝试在conf.py这个代码的变化我无法找到我应该connect（）的应用程序对象： def maybe_skip_member

8热度

1回答

在狮身人面像中，我如何创建可链接的“术语”部分而没有大量开销？

我想创建一个“术语”部分，其中包含我正在使用的术语的定义，以便每次使用此术语部分中的术语时，都会创建一个指向该定义的链接。目前，我能想起来的最好的是： .. |flavor| replace:: `:ref:flavor` .. _flavor: flavor ------ blah blah blah 后来的后来，在其他文本我必须做的： ''' This is a usage