使用mkdocs在Django项目中的URL生成API文档

时间:2015-09-10 21:05:59

标签: python django mkdocs

我倾向于在Markdown中编写我的API文档,并使用MkDocs生成静态站点。但是,我想要托管文档的网站是Django网站。所以我的问题是,我似乎无法找到答案谷歌搜索,我将如何在/api/v1/docs之类的位置托管MkDocs静态生成的网站文件,并让静态网站可以查看URL?

更新 我应该指出我在Apache下提供所有静态文件并且不使用runserver或Debug模式来提供静态文件,这只是疯了。该站点完全构建并与REST API一起使用。

我的问题是如何让Django(或者我应该说Apache)为MkDocs在某个URL下生成的静态站点(对于我的API文档)提供服务。我理解如何为网站提供媒体和静态文件,但不一定知道如何提供MkDocs生成的内容。它会生成一个完全静态的网站。包含HTML和资产文件的目录。

3 个答案:

答案 0 :(得分:3)

Django只是一个托管静态文件并使用Nginx或Apache等提供服务的框架。

答案 1 :(得分:1)

我认为你需要在apache中使用alias指令并使用它将某些URL重定向到静态文档站点。

答案 2 :(得分:-1)

来自文档

urls = [
    static(settings.STATIC_URL, document_root=settings.STATIC_ROOT),
    ("/home","views.home"),
    ...

 ]

https://docs.djangoproject.com/en/1.8/howto/static-files/#serving-static-files-during-development

在您的请求中,您将更改为

 static("/api/v0/docs",document_root="/home/docs/")