Warning: file_get_contents(/data/phpspider/zhask/data//catemap/2/django/19.json): failed to open stream: No such file or directory in /data/phpspider/zhask/libs/function.php on line 167

Warning: Invalid argument supplied for foreach() in /data/phpspider/zhask/libs/tag.function.php on line 1116

Notice: Undefined index: in /data/phpspider/zhask/libs/function.php on line 180

Warning: array_chunk() expects parameter 1 to be array, null given in /data/phpspider/zhask/libs/function.php on line 181

Warning: file_get_contents(/data/phpspider/zhask/data//catemap/0/jpa/2.json): failed to open stream: No such file or directory in /data/phpspider/zhask/libs/function.php on line 167

Warning: Invalid argument supplied for foreach() in /data/phpspider/zhask/libs/tag.function.php on line 1116

Notice: Undefined index: in /data/phpspider/zhask/libs/function.php on line 180

Warning: array_chunk() expects parameter 1 to be array, null given in /data/phpspider/zhask/libs/function.php on line 181
将Sphinx文档与django集成_Django_Python Sphinx - Fatal编程技术网

将Sphinx文档与django集成

将Sphinx文档与django集成,django,python-sphinx,Django,Python Sphinx,我已经为django项目创建了sphinx文档。它创建了一个构建文件夹、一个html文件夹和一个index.html文件。我不确定的是如何将index.html文件集成到我的项目中。是否可以简单地将它添加到url配置中,以及它将如何格式化?IMO,最好的方式是在HTTP服务器级别,而不是Django本身(至少我过去是这样做的)。您不需要或不希望任何Django层来提供sphinx文档,您只需要一个“香草”web服务器设置即可 此外,如果您坚持使用Django,这可能会有所帮助。。。不过,我还是建

我已经为django项目创建了sphinx文档。它创建了一个构建文件夹、一个html文件夹和一个index.html文件。我不确定的是如何将index.html文件集成到我的项目中。是否可以简单地将它添加到url配置中,以及它将如何格式化?

IMO,最好的方式是在HTTP服务器级别,而不是Django本身(至少我过去是这样做的)。您不需要或不希望任何Django层来提供sphinx文档,您只需要一个“香草”web服务器设置即可


此外,如果您坚持使用Django,这可能会有所帮助。。。不过,我还是建议在根目录下设置一个/docs目录,并通过基本的Apache/NGINX/etc配置将其指向sphinx数据。

将sphinx文档集成到Django中有一些很好的用例:

  • 允许文档中包含动态内容(即用户登录、当前时间等)
  • 将文档与整个站点地图集成
  • 只需创建和维护一组模板/CSS文件

如果您有一个或多个这样的需求,我会看一看,它可以直接处理所有基本用例,但是可以很容易地修改。

。django sphinxdoc将是完美的,除非我使用的是一个旧的django项目。与某些django sphinxdoc依赖项不兼容。符号链接工作得很好。我把它连接到管理界面。客户非常高兴:)我的项目根目录中有文档/项目/文档。。。你知道我可以为nginx配置一个教程,这样我就可以将sphinx数据指向它了吗?谢谢:)