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

Question

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

更新： 我应该指出我确实在 Apache 下提供所有静态文件并且不使用 runserver 或调试模式来提供静态文件，这太疯狂了。该站点已完全构建并与 REST API.

一起工作

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

Answer 1

Django 只是一个框架，您需要它来托管静态文件并使用 Nginx 或 Apache 等服务来提供它们。

Answer 2

来自文档

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/")

Answer 3

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

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

Hosting API docs generated with mkdocs at a URL within a Django project

python

django

mkdocs