问题标签 [read-the-docs]

我正在尝试将我的 Sphinx 文档与ReadtheDocs链接起来。我可以在本地构建文档，但是当我尝试让ReadtheDocs自动生成文档时，我收到以下错误：

狮身人面像标准错误

我的项目名称是 mousedb。我不明白为什么我在自动构建中收到此导入错误，但在本地却没有。

更新

根据评论，我认为这是将我的设置文件导入同级Docs目录的问题。settings.py我应该根据and的位置进行相对导入，而不是进行绝对导入（就像我一直在做的那样）conf.py。

我想将我的设置文件导入到我conf.py的目录结构中：

目前，我能找到获取 readthedocs.org 使用的当前设计资产的唯一方法是安装完整的主题并构建它，这需要 SASS 等。

我只想获得一组静态文件，让我在本地查看我的构建在 readthedocs 上的样子。有没有办法在不从上面的链接自己构建资产的情况下做到这一点？目标是让新手更容易为文档做出贡献。

我为我的项目编写了一些文档（在 Python 文档字符串中），并在本地计算机上使用 Sphinx 测试了所有内容——一切正常，所有导入工作正常等等。因此，我在 Read The Docs（和我的库）上设置了一个自定义环境Python 3，将目录（和子目录）添加到我的 Github 存储库中，并且 Read The Docs 上的构建通过了，但是，没有创建任何内容（链接只显示Nginx 404 页面）。日志如下：numpydocdocsdocs/sourceView Docs

我的conf.py有

所以，我不知道为什么automodule被列为未知指令。

我想在使用sphinx-rtd-theme. 我试过将它添加到目录树中：

但这导致

从狮身人面像，没有其他效果。

我想我可以简单地对主题文件中的索引进行硬编码layout.html，但也许有更好的方法，不涉及修改标准主题？

TIA 的任何提示！

链接到说明

我正在按照http://read-the-docs.readthedocs.org/en/latest/install.html#solr-search-setup上的说明进行操作

问题

目前，我可以设置 readthedocs.org 的本地实例；但是，我无法正确设置搜索，因为我似乎无法通过运行以下命令生成必要的 schema.xml 文件。其中的上下文在上面的链接中。

我没有成功生成 schema.xml，而是出现了这个错误。

我猜有一个额外的步骤涉及在生成 xml 之前使用 django 配置 solr。类似的错误建议编辑 settings.py 文件，但我似乎无法在项目目录中找到一个。由于我对 django 不熟悉，我不知道如何从这里继续。

我正在尝试使用 sphinx 来记录文档的多个“级别”，例如：

• 接口参考
• 手动的
• 教程
• 等等。

这个想法是，目录显示在相对于您所在部分的侧边栏上。因此，当您在主索引上时，它仅显示上述部分。当你进入例如。“手动”它显示了特定于该部分的不同 ToC，以及返回主 ToC 的方法。

我一直在试图弄清楚如何在不入侵的情况下让它在 Sphinx 中工作，但到目前为止还不太清楚。文件夹结构已经反映了不同的部分（即所有“手册”文档都存储在 _source/manual 下），我尝试在每个目录中放置单独的索引文件，但似乎 toctree 功能只查看主索引文件。

我正在使用“readthedocs”主题，我正在查看的代码是https://github.com/snide/sphinx_rtd_theme/blob/master/sphinx_rtd_theme/layout.html#L93

谁能告诉我如何使用 Sphinx 添加这样的 ToC？

谢谢

我有一个使用plot-directive的 python-3 项目，但目前ReadTheDocs不支持。因此，我想像通常使用 PyPi 存储库一样生成和上传文档，但使用该-r选项指定不同的 url。

我尝试了以下方法，但失败了：

我也尝试了以下网址，但没有任何效果：

• https://readthedocs.org/pypi/wltp
• https://readthedocs.org/pypi/wltp/latest
• https://readthedocs.org/wltp/pypi
• https://readthedocs.org/wltp/latest/pypi/

我想要实现的（原则上）可能吗？

我有一个python-3项目，它使用plot-directive动态生成和嵌入 matplotlib 的图表，我正在使用ReadTheDocs自动生成项目的文档。
plot-directive在 python-2 中确实可以正常工作，但它目前在 python-3 中失败。

具体来说，我在 RTD 日志上遇到的失败是：

构建标准错误

罪魁祸首可以追溯到 matplotlib 由于 mnissing 'freetype' C lib 而没有被编译：

设置输出

为了使文档生成通过，我不得不按照 RTD FAQ 中的说明，使用文件中的以下代码，通过模拟它来“禁用”绘图指令./conf.py。

我尝试了virtualenv（有或没有站点包可见性）、 rtd-specific的各种组合，但requirements.txt没有成功。

有没有人找到办法做到这一点？

对于那些愿意深入研究这个问题的人来说，这些是一些提示：

• RTD 上预装本机库的“官方”列表
• 用于设置构建服务器的实际文件，可从 RTD 的源代码中找到。pip-requirements.txt

我使用没有任何宽度或高度修饰符的别名来显示图像：

此图像正确渲染，没有任何装饰。

我添加了一个高度修改器来调整这个图像的大小：

当我这样做时，我的 readthedocs 页面会显示此图像，下方有一条灰线：

发生的情况是锚标记（无论出于何种原因）被包裹在img该图像的标记周围，并且锚标记应用了文本装饰样式，这添加了灰色下划线。

我该如何防止这种情况发生？将鼠标悬停在图像上时，我不需要下载图像。我只想显示图像。

我在一个文件夹中有一堆 md 文件，但我想指定它们在左侧索引中显示的顺序。有没有办法做到这一点？