文档(sphinx)和django app之间的链接

时间:2012-05-09 09:06:19

标签: django documentation python-sphinx

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

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

如果有更好的方法,我可以取代狮身人面像。但是我希望将文档保留在文件系统中的修订控制中(而不是在数据库中)。

任何提示?

1 个答案:

答案 0 :(得分:1)

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