【问题标题】:Why doesn't ReadTheDocs show "Last updated on"为什么 ReadTheDocs 不显示“上次更新时间”
【发布时间】:2016-08-17 22:34:09
【问题描述】:

我有一个documentation 由 ReadTheDocs 渲染并托管。它仍然显示 Git 提交哈希而不是“上次更新时间”行,而我的本地 HTML 文档显示今天的日期。

本地版本:

在线版:

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

为什么 ReadTheDocs 会忽略我的设置?如何获取最后更新日期?

【问题讨论】:

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


    【解决方案1】:

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

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

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

    【讨论】:

      猜你喜欢
      • 1970-01-01
      • 1970-01-01
      • 2011-05-26
      • 2021-09-28
      • 2013-08-12
      • 1970-01-01
      • 2020-08-28
      • 2015-03-09
      • 1970-01-01
      相关资源
      最近更新 更多