为什么ReadTheDocs没有显示“上次更新时间”

时间:2016-08-17 22:34:10

标签: configuration-files python-sphinx read-the-docs

我在ReadTheDocs上呈现并托管documentation。它仍显示Git提交哈希而不是“上次更新”行,而我的本地HTML文档显示今天的日期。

本地版本: enter image description here

在线版 enter image description here

docs/conf.py文件中,我将html_last_updated_fmt配置为非None值 - >空字符串。
资料来源:https://github.com/VLSI-EDA/PoC/blob/master/docs/conf.py#L173-L176

为什么ReadTheDocs会忽略我的设置?我怎样才能获得最后更新的日期?

1 个答案:

答案 0 :(得分:2)

如果有可用的修订信息(here's the commit that introduced the change),则ReadTheDocs默认主题会将Last updated信息替换为修订信息。

要解决此问题,您可以创建和使用自定义主题。 这不是微不足道的。请按以下步骤操作:

  • 分叉ReadTheDocs主题。
  • "撤消"我上面提到的提交的更改。
  • 在文档的requirements文件中引用fork。 Here,您可以看到需求文件的示例。但是,该文件通常应位于存储库的根目录中,并且名称为requirements.txt
  • 确保您的项目已配置为支持installation of custom requirements
  • 将所有更改推送到GitHub。
  • 在ReadTheDocs上重建您的项目。