问题标签 [read-the-docs]

我正在使用 mkdocs 从 Markdown 构建 hendrix 文档。

当显示在readthedocs上时，文档没有标题的锚链接。

我想用我自己的自定义样式扩展Sphinx和ReadTheDocs使用的主题。

我可以做到这一点的最佳方法是什么，以便我的更改能够坚持下去？

我正在使用 Doxygen、Breathe 和 Sphinx 创建一些我想放在的文档 阅读有关简单 C# 库的文档。最初，我的make.bat脚本给了我很多错误，我意识到这是由于在 Doxygen 中使用了完全限定的名称；我通过 DoxygenHIDE_SCOPE_NAMES选项解决了这个问题。

不幸的是，我的属性仍然没有正确记录。一方面，与为我的方法生成的文档不同，该属性的名称仍然是完全限定的（即NAMESPACE::CLASS::PROPERTY）。此外，生成的 Read the Doc 文档不包含属性的数据类型，并且没有正确提取评论标签。我的 C# 代码如下所示：

但生成的文档如下所示：

属性 NAMESPACE::CLASS::Property

获取或设置属性。

该物业。

我想看到这样的东西：

属性 int 属性

摘要：获取或设置属性。

价值：财产。

有谁知道如何达到这个效果？

该make.bat脚本也继续给我这些属性的错误。

尝试在内部自托管阅读文档，但对 Django 的经验很少。

我已经按照readthedocs上的所有步骤（在我拥有的 /usr/share/ 中创建 virtualenv 并拥有组所有权 www-data）用于开发网络服务器，并且效果很好。

已采取以下附加步骤将 wsgi 和 apache 设置为 selfhost：

• 安装了额外的依赖

  • sudo apt-get install libapache2-mod-wsgi libpq-dev redis-server
  • cd /usr/share/readthedocs/
  • pip install psycopg2 redis django-redis-cache django-redis-sessions
  • pip install --upgradehiredis

• 配置redis监听socket并放宽权限到777

apache被配置为一个虚拟主机：

并且流量似乎正确地流向了后端。然而，RTD 抱怨缺少 REDIS 属性。Apache 错误日志输出：

我意识到我还需要启用弹性搜索并进行正确配置，但是当我走到那一步时，我会越过那座桥。

更新：发出grep -i redis /usr/share/readthedocs/checkouts/readthedocs.org/readthedocs/settings/*返回的命令

所以我重新配置redis不再使用套接字并返回绑定/端口，但问题仍然存在（使用相同的堆栈跟踪）。

阅读文档不会为我的包构建文档，因为它包含 matplotlib。我使用他们网站上的代码来模拟 matplotlib，但构建仍然失败，因为构建 matplotlib 需要 freetype 和 png，而且显然这没有安装在他们的机器上。我尝试过在 virtualenv 中构建和不构建。

这是我的 config.py。

为什么我的模拟不起作用？

我正在尝试使用 ReadTheDocs 记录一个 Python 项目。最初，构建过程会在以下情况下终止：

我已经阅读了rtd 常见问题解答，并为给我带来麻烦的 osgeo 模块使用了 mock。现在构建过程使它通过了导入，但阻塞了：

有了这个相当无益的错误：

我对使用 mock 完全陌生，但我认为问题在于它osgeo是一个 mock 模块，因此没有 submodule gdalconst。我该如何解决？有没有办法模拟子模块？

在阅读文档的几个项目（包括我自己的项目）中，我看到此错误消息的变体：“TypeError make_toctree at ... is not JSON serializable”。

例子是：

https://readthedocs.org/projects/hgvs/builds/3334927/ https://readthedocs.org/projects/pyhatch/builds/3270548/ https://readthedocs.org/projects/xymath/builds/3300272/

文档在本地构建良好。

有关如何调试此问题的任何建议或对原因的怀疑？

（也在https://github.com/rtfd/readthedocs.org/issues/1676询问）

我最近开始使用Read The Docs，一切都很顺利。今天我尝试在 Read The Docs 上构建我的项目的开发分支。构建失败。经过几个小时的调试后，我切换回未更改的主分支并尝试再次构建。构建失败。我不明白 master 分支昨天为什么或如何成功构建，但今天它的构建失败了。

这是我在构建页面上获得的回溯：

接下来是两个命令，这两个命令似乎都成功了。为了调试它，我查看了其他 Read The Docs 项目，我看到许多成功构建了数周，但今天却因同样的错误而失败。这个错误的有趣之处在于它没有提供有形的来源。许多其他项目都有ImportError更具体的错误或其他错误。如果我不清楚这个错误有多模糊，这里是页面的图像：

这两个命令似乎都成功了。我没有提供我自己的conf.py，也没有提供conf.py.conf（尽管我什至不知道那个文件是什么，尽管我有 google-fu），我也没有提供任何配置文件。我一直让 Read The Docs 自动生成它需要的一切。

我的项目昨天建成。我没有以任何方式更改来源。今天，它不会建造。我怎样才能解决这个问题？

我正在为一个项目使用 Read The Docs。一切似乎都在网上运作良好。但是，当我下载 HTML 以供离线使用时，我发现文档都被塞进了一个 HTML 文件 (index.html)。是否可以下载文档，使其具有与具有单独链接页面的在线文档相同的外观和感觉？

我尝试从 RTD Admin > Settings 页面在三个选项（Sphinx Html、Sphinx HtmlDir 和 Sphinx Single Page HTML）之间更改文档类型，但这些似乎都没有明显改变在线内容或下载的 HTML 结构。

从 Sphinx 生成的 Python 文档确实有单独的 HTML 文件。然而，Read The Docs 自己的文档也作为单个 HTML 文件下载。

我是否遗漏了什么，或者这是 Read The Docs 的限制？

• 我的阅读文档网站在这里：http: //kiva.readthedocs.org/en/docs/
• 我的 GitHub 存储库在这里：https ://github.com/nealkruis/kiva/tree/docs/docs

我尝试在 Sphinx 中进行扩展，其想法是扩展检测部分的标题，然后将它们转换为折叠部分，即 sphinx 呈现带有前缀按钮的标题，该按钮有助于显示或不显示的内容部分。

我开始写这样的扩展：

但这里的问题是： - 我不知道将按钮与 onClick 函数绑定，这会使点击时的主要消失。- 主要内容只是放入原始 html，这不是最佳的，因为如果它们还包含子指令，它们将不会被处理。- 如果我必须选择，那么狮身人面像的文档真的很难理解，因此在这种情况下会调用一些节点。一般实例，但我不知道具体是什么。

谢谢