允许为Django生成的Sphinx文档提供服务。
django-docs的Python项目详细描述
django docs允许直接从django提供sphinx生成的文档。
依赖关系
- 用于django 1.8-1.11的python 2.7-3.6
- Django 2.0或更高版本的Python 3.4-3.6
安装
安装django文档包:
pip install django-docs
将文档添加到“设置”中已安装的应用程序。py:
INSTALLED_APPS = ( ... 'docs', ... )
将docs.url添加到url.py:
urlpatterns = [ ... url(r'^docs/', include('docs.urls')), ... ]
自定义配置:
DOCS_ROOT = os.path.join(PROJECT_PATH, '../docs/_build/html') DOCS_ACCESS = 'staff'
配置
文件根目录(必需)
sphinx生成的html文档根目录的绝对路径(就像静态根/媒体根设置一样)。
文档访问(可选)
文档访问级别(默认为公共)。可能值:
- 公共(默认)文档对所有人都可见
- 需要登录-只有经过身份验证的用户才能看到文档
- staff-文档仅对staff用户可见(user.is_staff==true)
- 超级用户-文档仅对超级用户可见(user.is_superuser==true)
运行测试
确保首先安装test_requirements.txt
pip install -r test_requirements.txt pip install -e .
您可以使用via运行测试:
python setup.py test
或:
python docs/tests/runtests.py
要对不同版本的django运行所有测试,只需运行:
tox
运行示例项目
确保首先安装requirements.txt
virtualenv env . env/bin/activate pip install -r test_requirements.txt pip install -e .
您可以使用via运行示例项目:
cd example python manage.py migrate python manage.py runserver