【问题标题】:Links between documentation (Sphinx) and Django app文档(Sphinx)和 Django 应用程序之间的链接
【发布时间】:2012-05-09 09:06:18
【问题描述】:

我有使用 Sphinx 编写的应用程序用户的文档。到目前为止,文档都是用户可以访问的静态 HTML 页面。

我想在应用程序和文档之间创建链接。当然,我可以使用脆弱的 <a href=".."> 链接来做到这一点,但我想使用 reverse() 从 Sphinx 链接到视图,并使用 sphinx-reference 从应用程序链接到文档。

如果有更好的方法,我可以替换 sphinx。但我想将文档保存在文件系统(而不是数据库)中的修订控制中。

有什么提示吗?

【问题讨论】:

标签: django python-sphinx


【解决方案1】:

查看 readthedocs.org。您可以让他们托管您的文档,或者您可以从 GitHub 下载他们的应用程序并将其集成到您的应用程序中。 (https://github.com/rtfd/readthedocs.org)

【讨论】:

  • 这是一个商业 django 应用程序,文档应该从同一个(内部网)主机提供。手工编写的链接 (
  • 我相信 readthedocs.org 的源代码可以在我之前消息中的链接中找到——这样你就可以在你的 Intranet 上运行。
猜你喜欢
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 2016-05-26
  • 2014-07-30
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
相关资源
最近更新 更多