1

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

更新: 我应该指出我确实在 Apache 下提供所有静态文件,并且不使用 runserver 或调试模式来提供静态文件,这太疯狂了。该站点是完全构建的,并且与 REST API 一起工作。

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

4

3 回答 3

4

Django 只是一个框架,您需要托管静态文件并使用 Nginx 或 Apache 等服务。

于 2015-09-10T21:15:20.807 回答
2

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

于 2015-09-11T23:24:25.437 回答
-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/")
于 2015-09-10T21:15:49.403 回答