问题标签 [python-sphinx]

（使用 Python-Sphinx 文档工具）

我有一个.txt想要构建到_build/html unaltered中的日志文件。我需要在 , 等中更改conf.py什么index.rst？

这是布局：

如何somefile.txt进入 html 构建？我尝试将这样的行添加到index.rst：

希望它能通过魔法起作用，但这里没有魔法！

假设这甚至是可能的，我会输入什么some_doc.rst来引用/链接到该文件？

注意 是的，我知道我可以将它放在/static中，然后就可以完成它，但这似乎完全是 hack，而且丑陋。

跑步时

在我的doc/目录中，我得到以下输出：

这个文件有numpy导入，经过一番研究，似乎 sphinx 使用的 RST 标记的numpy记录方式有问题。当我取出 numpy 导入时，html 构建良好。

解决此问题的最佳方法是什么？

我使用Sphinx来记录 Python 模块。我有一个主doc目录，我在其中放置*.rst了要包含在index.rst主文件中的各个文件（每个模块组件都在上面）。这很好用（请查看Python 库参考的源代码以了解我是如何做到的）。

我的问题是当我需要为给定的模块组件（而不是整个模块）创建独立的 PDF 时。

假设您的完整模块（库）的结构与Python 库参考中的结构相同，然后您需要为crypto组件文档创建一个独立的 PDF。你会怎么做？

1. 创建不同的索引 ( index_2.rst) 并仅包含该文件 ( crypto.rst)
2. 评论原始文件中的其他文件index.rst
3. crypto在带有独立 Sphinx 文档的内部创建一个全新的 doc 目录

这些方法似乎都不是直截了当的。

建议，请。

我有一个 PDF，其中对我拥有的包的 Sphinx 文档中的示例进行了一些深入的解释。有没有办法轻松地将 PDF 包含在我的项目中（并在我构建文档时复制它）？我尝试使用 :doc: 链接到它，但这并没有复制它。

我写了一个小模块，我想知道打包它以将其发送到pypi的基本步骤是什么：

• 什么是文件层次结构？
• 我应该如何命名文件？
• 我应该使用 distutils 创建 PKG-INFO 吗？
• 我应该在哪里包含我的文档（用 sphinx 制作）？

我正在尝试使用 Sphinx 来记录我的 Python 类。我使用自动文档这样做：

虽然它正确地为我的方法获取文档字符串，但那些被装饰的：

与@checkStale存在

有一个不正确的原型，例如open(*args, **kwargs).

我怎样才能解决这个问题？我的印象是使用@wraps会解决这种事情。

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

使用 Sphinx，我正在https://bitbucket.org/omidraha/pylearn/编辑 pylearn 文档内容。

所有段落都是从右到左（因为波斯语）和文本之间的代码示例，呈现不正确。

一般来说，我正在寻找一种在网页上应用 unicode 或 microsoft 的双向算法的方法。

有没有办法将代码的 css 样式设置为 RTL 段落中的 LTR？如果没有，我怎么能修改 sphinx 源来做单独的代码示例，例如在框架或类似的东西中？

我想使用sphinx 的 autodoc-skip-member事件来选择某个 python 类上的一部分成员进行文档。

但是从 sphinx 文档中并不清楚，我找不到任何示例来说明：我在哪里放置代码来连接它？我看到Sphinx.connect并且我怀疑它在我的 conf.py 中，但是当我在 conf.py 中尝试此代码的变体时，我找不到我应该连接（）的应用程序对象：

指向一个简单示例的指针将是理想的。

我想创建一个“术语”部分，其中包含我正在使用的术语的定义，这样每次我使用此术语部分中的术语时，都会创建一个指向定义的链接。

目前，我能想到的最好的是：

然后，在其他文本中，我必须这样做：

我发现上面的语法非常麻烦。我知道我可以使用另一层脚本或 m4 来自动生成这种语法，但我希望有更好的方法..