Responsive Django Admin 技术文档

1. 安装指南

在安装 Responsive Django Admin 前，请确保您的环境中已安装了 Django。以下为安装步骤：

$ pip install bootstrap-admin

安装完成后，需要在 Django 项目的 INSTALLED_APPS 配置中添加 bootstrap_admin，且需放置在 django.contrib.admin 之前。

例如：

INSTALLED_APPS = (
    # ...
    'bootstrap_admin',  # 始终位于django.contrib.admin之前
    'django.contrib.admin',
    # ...
)

2. 项目的使用说明

Responsive Django Admin 是一个使 Django 管理界面响应式和易于使用的插件。它支持 Django 1.11、2.1、2.2 和 3.0 版本，并且基于 Bootstrap 3 设计。

侧边栏菜单

侧边栏菜单默认启用。如果需要禁用，可以从项目的 context_processors 中移除 django.template.context_processors.request，然后设置：

BOOTSTRAP_ADMIN_SIDEBAR_MENU = False

品牌定制

如果想要使用自己的品牌标识（如LOGO），可以通过覆盖 login.html 和 base_site.html 实现，与 Django Admin 的方法相同。

首先，确保在 settings.py 中的 TEMPLATES 设置正确配置了模板路径：

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [os.path.join(BASE_DIR, 'my_django_project/templates')],
        'APP_DIRS': True,
        # 其他配置
    },
]

在 DIRS 中设置模板位置，这里假设 BASE_DIR 是项目的根目录。

以下是一个示例项目结构：

my_django_project/
│
├── core/
│   ├── admin.py
│   ├── apps.py
│   ├── models.py
│   ├── tests.py
│   └── views.py
│
├── settings.py
├── templates/
│   └── admin/
│       ├── base_site.html
│       └── login.html
│
├── urls.py
└── wsgi.py

在 base_site.html 和 login.html 文件中，您可以按照以下方式定制内容：

base_site.html

{% extends 'admin/base_site.html' %}
{% load static %}

{% block branding %}
    <a href="{% url 'admin:index' %}" class="django-admin-logo">
        <!-- 自定义品牌 -->
        <img height="60" src="{% static "bootstrap_admin/img/logo-140x60.png" %}" alt="自定义品牌">
    </a>
{% endblock branding %}

login.html

{% extends 'admin/login.html' %}
{% load i18n static %}

{% block branding %}
    <a href="{% url 'admin:index' %}" class="django-admin-logo">
        <!-- 自定义品牌 -->
        <img height="60" src="{% static "bootstrap_admin/img/logo-140x60.png" %}" alt="自定义品牌">
    </a>
{% endblock branding %}

3. 项目API使用文档

Responsive Django Admin 主要通过覆盖 Django Admin 的模板来实现功能，因此没有提供特定的 API。它的使用主要涉及在 Django 设置中配置相关参数和覆盖默认模板。

4. 项目安装方式

如安装指南所述，项目主要通过 PyPI 安装，通过以下命令：

$ pip install bootstrap-admin

然后，在 Django 项目的 settings.py 文件中按照上述说明配置 INSTALLED_APPS。