问题标签 [python-sphinx]

问题：我正在尝试使用reStructuredText编写“并行文本” 。我所说的“平行文本”是指带注释的小说作品，其中文本分为两列。左栏包含正文，右栏包含评论。我将使用sphinx从中生成 HTML 和 Latex 文档。

我有以下要求：

1. 如上所述，我应该能够在两列中排版文本，一列用于正文，一列用于注释。
2. 注释可以是“句子级别”，并不总是“段落级别”。即，我希望能够在一个段落或整个段落中注释不同的句子。
3. 关闭所有注释的模式会很棒，因此输出的 HTML 和 Latex 仅包含正文。在这种情况下，我希望能够使用媒体的整个“房地产”，而不仅仅是一个专栏。
4. 如果可能的话，拥有“注释列表”功能会非常好。

我对 reStructuredText 和 Sphinx 还很陌生，但对 Python 有相当多的经验。我正在寻找一些关于如何做我想做的事情的想法。我一直在阅读有关 reStructuredText 以及编写 Sphinx 扩展的内容，因此为 Sphinx 编写扩展并不是不可能的。

有没有人做过类似的事情？

谢谢！

我正在尝试使用它来构建sphinx-build . doc它给我警告：

可能是什么原因？

我认为从 Sphinx 生成的表格并不漂亮，因为它为表格生成了以下 HTML 代码。

我怎样才能变成漂亮的，例如斑马桌？

HTML 生成的 html 有 jQuery，根据这个站点，只需一行代码即可拥有斑马表，但我不知道如何使用 jQuery 制作斑马表。

• 问：如何在 Sphinx 中使用 jQuery？
• 问：有没有其他方法可以使用 Sphinx 制作斑马桌？

使用 ReST/Sphinx 标记 RESTful Web 服务的方法/URL 的最佳方式是什么？是否有适合用可能的参数、HTTP 方法、标头和正文内容标记 URL 的默认域？

类似于以下内容：

这样的东西是否已经存在或者是可用的默认扩展之一，还是我必须自己编写一个？

我正在寻找在 reStructured Text 中让图像旁边出现文本的最佳方式。我发现几个网站声称展示了它是如何完成的，但没有一个展示实际运行的示例。有几个显示了似乎失败的例子。我实际上正在使用 Sphinx (v0.6.6) 并希望避免过度使用它附带的“本机”CSS。

我需要为每个模块创建一个 sphinx 项目，

每个模块共享一些共同的 rsts，如公司信息、许可证等。

我的项目树是这样的：

我在 ./device1/index.rst 中写了这个，但它不起作用，我如何导入父 rst 文件？

我正在尝试在我的网站上使用从 reStructuredText 生成的 jQuery lightBox 实现。灯箱将图像周围链接的标题作为灯箱显示中图像的标题。

但是，我似乎无法在 reStructuredText 中找到在链接上提供标题属性的方法 - 有人知道这样做的方法吗？我的图像定义如下：

所以我可以添加一个alt属性，但不能添加一个标题。一种可能的替代方法是使用目标作为参考，如下所示：

在后一种情况下，我不确定如何向底部定义的链接添加属性（如果可能的话）。

我正在尝试使用 Sphinx 为 python 项目自动生成文档。其中一个模块需要 scipy.signal 包，我尝试使用以下命令导入：import scipy.signal as signal。虽然代码运行得很好，但使用 Sphinx 制作 html 会导致分段错误（下面的输出）。但是，我可以使用“import scipy as sp”，确保将 scipy 目录放在我的 sys.path 中，并且生成的文档没有任何问题，但是当然，我的代码中将没有我的功能需要。

我做了一个非常简单的测试用例来演示这个问题，用几个文档字符串创建了一个测试类。我将它与我的 .rst 一起包含在下面。注释掉“import scipy.signal as signal”这一行，一切正常。

感谢您对如何在导入 scipy.signal 的同时避免段错误的任何见解。劳伦

狮身人面像输出：

pyexample.py

索引.rst

文档字符串.rst

我是一群狂热的作家中的一员，他们决定合作为一种编程语言编写一本食谱风格的书。

我们正在尝试为合作选择一个管道。

我喜欢ProGit的制作方式。

那就是 Markdown + 一些自定义的预处理，由 Pandoc 处理。但我担心 Markdown 对于我们的案例来说太简单了。

我看Sphinx，但我没有使用它的经验。

我知道 LaTeX 会起作用——但我担心它会吓跑贡献者。此外，如果您没有必要的经验（我没有），那么构建拜占庭管道可能太强大且太容易了。

请不要建议一个人必须手动编写 XML 或必须使用某些特定GUI 的解决方案（当然，可选的 GUI 是好的）。商业和非跨平台解决方案也不是一种选择。

我正在尝试使用 Sphinx 为我的代码库自动生成基本文档。但是，我很难指示 Sphinx 递归扫描我的文件。

我有一个 Python 代码库，其文件夹结构如下：

我在 中运行 sphinx-quickstart <workspace>，所以现在我的结构如下所示：

我已经阅读了快速入门教程，尽管我仍在尝试理解文档，但它的措辞让我担心 Sphinx 假设我将为我的代码库中的每个模块/类/函数手动创建文档文件.

但是，我确实注意到了“automodule”语句，并且在快速启动期间启用了 autodoc，所以我希望大部分文档都可以自动生成。我修改了我的 conf.py 以将我的 src 文件夹添加到 sys.path，然后修改我的 index.rst 以使用自动模块。所以现在我的 index.rst 看起来像：

我在子包中定义了几十个类和函数。然而，当我运行时：

它报告：

这似乎无法在我的包中导入任何内容。查看生成的 index.html 在“Contents:”旁边没有显示任何内容。索引页面只显示“mypackage (module)”，但点击它显示它也没有任何内容。

如何指导 Sphinx 递归解析包并为它遇到的每个类/方法/函数自动生成文档，而不必自己手动列出每个类？