标签: read-the-docs

许多开源项目在文档页面的右上角使用“Fork me on Github”横幅。

仅举一个例子，让我们以 Python请求为例：

Github 博客上有一篇关于提供图像代码的横幅的文章：GitHub Ribbons

但没有解释如何在使用 Sphinx 生成的每个页面中添加链接，然后上传到 ReadTheDocs。

你能帮忙自动生成这个吗？我预计会有一个选项，conf.py但我没有找到。我的 Sphinx 配置是默认配置。

我是第一次使用“阅读文档” 。我正在为命令行系统编写文档，我的“代码示例”包括 shell 输出的日志。shell 输出最终看起来像这样

也就是说，服务（或者我对它的使用？）正在尝试将运行 shell 命令的示例格式化为源代码，并将 视为magento2:generate类常量。

我可以控制哪些代码块在阅读文档时获取源代码格式吗？我尝试在管理中不设置基本语言，但似乎没有效果。或者这是我需要在 sphinx 级别的 mkdocs 中控制的东西？（通过将 Markdown 或 sphinx 文件转换为漂亮的 HTML 文件来阅读文档）或者其他什么？还是我运气不好？

我正在为 mkdocs 中的一个项目创建一个指令列表，我相信该项目使用 python-markdown 作为其 markdown 引擎。但是，当我尝试在列表中的数字之间放置围栏代码块时，它会导致编号错误。

一个让我失望的例子（我还尝试在每个反引号栅栏和实际单词之间添加换行符，但它仍然弄乱了编号）：

1. Click this
```
some code
```
2. Click that

呈现出这样的效果：

1. Click this

some code

1. Click that

然后，当我尝试缩进它时，它只会弄乱渲染：

1. Click this
    ```
    some code
    ```
2. Click that

到

1. Click this ``` some code ```
2. Click that

是的，制表符可以工作，但是如果我想用 ```language. 有没有办法既保留受隔离的代码块，又保留列表编号。

我正在开发 mkdocs 网站。在这里我需要为我的网站添加网站图标。我尝试了这样的方法，但它不起作用。

我在 mkdocs.yaml 文件中添加了 site_favicon 并使用 readthedocs 主题。但它不起作用

site_favicon: img/favicon.ico

谁能帮我这个？

我在 github 上有一个存储库：

https://github.com/springer-math/Mathematics-of-Epidemics-on-Networks

里面有一个文件

文档/SIR_2dgrid.mp4

其中包含我想出现在 readthedocs 文档中的动画（特别是在此页面：http://epidemicsonnetworks.readthedocs.io/en/latest/Simulation_Investigation.html）此外，还有一个文件

文档/Simulation_Investigation.rst

它对该页面进行编码并尝试引用该 mp4。我尝试了很多变体（尝试复制https://groups.google.com/d/msg/sphinx-users/_z00m3zoRAY/Ryx4D5sxgtcJ上的说明），但没有运气。我能让 mp4 出现在所需的 readthedocs 页面上的唯一方法是链接到 github 上的 mp4（但加载有点延迟，而且并不完美）。

我似乎无法通过 readthedocs 将 mp4 复制到可以建立相对链接的目录中。

有没有办法让 readthedocs 将该文件复制到我可以链接到的地方？

或者，除了将 mp4 放在另一个网站上之外，还有其他方法可以将视频嵌入到 readthedocs 中吗？

我曾经在 readthedocs.io 服务器上保存一个项目文档。这是CoFEA Initiative 的链接

自 4 月 3 日以来，由于发布了新版本的 docutils 库，它看起来有点破损（例如，主徽标向左对齐，而它应该居中）。docutils 的最新版本是 0.17，这个特定的 Sphinx 主题在 0.16 版本之前工作得很好。

日志文件显示了它不工作的原因。首先，readthedocs服务器安装最新版本的docutils

Collecting docutils>=0.11
  Downloading docutils-0.17-py2.py3-none-any.whl (575 kB)

然后 Sphinx 主题尝试根据中定义的内容下载并安装特定版本的 docutilssetup.py

Installed /home/docs/checkouts/readthedocs.org/user_builds/cofea/envs/latest/lib/python3.7/site-packages/ipygany-0.5.0-py3.7.egg
Searching for docutils==0.16
Reading https://pypi.org/simple/docutils/
Downloading https://files.pythonhosted.org/packages/81/44/8a15e45ffa96e6cf82956dd8d7af9e666357e16b0d93b253903475ee947f/docutils-0.16-py2.py3-none-any.whl#sha256=0c5b78adfbf7762415433f5515cd5c9e762339e23369dbe8000d84a4bf4ab3af
Best match: docutils 0.16
Processing docutils-0.16-py2.py3-none-any.whl
Installing docutils-0.16-py2.py3-none-any.whl to /home/docs/checkouts/readthedocs.org/user_builds/cofea/envs/latest/lib/python3.7/site-packages

我认为发生的情况是，当调用 Sphinx 命令时，它使用的是版本 0.17 而不是 0.16。

有没有办法强制为 Sphinx 使用 docutils 0.16 版本？