Django 一键部署私有 Sphinx 文档

在本文中，我们将介绍如何使用 Django 一键部署私有 Sphinx 文档的方法。Sphinx 是一个用于生成技术文档的工具，而 Django 则是一个强大的 Python Web 框架。将两者结合起来，可以方便地将生成的文档部署到一个私有的服务器上，以供团队成员或客户查阅。

阅读更多：Django 教程

准备工作

在开始部署之前，我们需要进行一些准备工作。首先，我们需要安装 Django 和 Sphinx：

pip install django sphinx

然后，我们需要创建一个 Django 项目和一个 Sphinx 文档项目：

django-admin startproject myproject
sphinx-quickstart

接下来，我们需要将 Sphinx 生成的静态 HTML 文档集成到 Django 中，并实现私有访问权限。在 Django 项目的 settings.py 中添加以下配置：

STATICFILES_DIRS = [
    os.path.join(BASE_DIR, 'build/html'),
]

STATIC_URL = '/static/'

然后，在 Django 项目的 urls.py 中添加以下路由配置：

from django.urls import path
from django.views.generic import TemplateView

urlpatterns = [
    ...
    path('docs/', TemplateView.as_view(template_name='index.html')),
]

接着，我们需要创建一个 Django 应用来管理文档的访问权限。在 Django 项目的根目录下运行以下命令：

python manage.py startapp docs

然后，在 docs 应用的 models.py 中定义一个 Document 模型：

from django.db import models

class Document(models.Model):
    title = models.CharField(max_length=100)
    file = models.FileField(upload_to='documents/')

并在 settings.py 中注册该应用：

INSTALLED_APPS = [
    ...
    'docs',
]

最后，运行以下命令来更新数据库：

python manage.py makemigrations
python manage.py migrate

部署私有 Sphinx 文档

现在，我们已经完成了准备工作，可以开始部署私有 Sphinx 文档了。首先，将生成的 Sphinx 文档保存到 Django 项目的 static_docs 目录下，并重命名为 docs：

cp -r build/html static_docs/docs

然后，在 docs 应用的 views.py 中添加以下代码：

from django.shortcuts import render
from docs.models import Document

def document_list(request):
    documents = Document.objects.all()
    return render(request, 'document_list.html', {'documents': documents})

并在 docs 应用的 urls.py 中添加以下路由配置：

from django.urls import path
from docs.views import document_list

urlpatterns = [
    ...
    path('', document_list, name='document_list'),
]

接着，创建 document_list.html 模板，并将其保存到 templates 目录下：

{% extends 'base.html' %}

{% block content %}
  <h1>文档列表</h1>
  <ul>
    {% for document in documents %}
      <li><a href="{{ document.file.url }}">{{ document.title }}</a></li>
    {% endfor %}
  </ul>
{% endblock %}

最后，运行以下命令启动 Django 项目：