允许从django提供Sphinx生成的文档。
项目描述
django-docs 允许直接从Django提供Sphinx生成的文档。
依赖项
Python 3.6+ 用于Django 3.0或更高版本
致谢
GitHub上的项目：littlepea/django-docs
安装
安装 django-docs 包
pip install django-docs
将 docs 添加到 settings.py 中的 INSTALLED_APPS
INSTALLED_APPS = ( ... 'docs', ... )将 docs.urls 添加到 urls.py
urlpatterns = [ ... url(r'^docs/', include('docs.urls')), ... ]自定义配置
DOCS_ROOT = os.path.join(PROJECT_PATH, '../docs/_build/html') DOCS_ACCESS = 'staff'
配置
DOCS_ROOT (必需)
到由Sphinx生成的html文档根目录的绝对路径（类似于 STATIC_ROOT / MEDIA_ROOT 设置）。
DOCS_ACCESS (可选)
文档访问级别（默认为公开）
public - （默认）文档对所有人可见
login_required - 文档仅对已验证用户可见
staff - 文档仅对工作人员用户可见（user.is_staff == True）
superuser - 文档仅对超级用户可见（user.is_superuser == True）
运行测试
请首先安装 test_requirements.txt
pip install -r test_requirements.txt pip install -e .
您可以使用以下方式运行测试：
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 .
您可以使用以下方式运行示例项目：
cd example python manage.py migrate python manage.py runserver
截图
下载文件
下载适用于您的平台文件。如果您不确定选择哪个，请了解更多关于 安装包 的信息。
源分布
django-docs-0.3.3.tar.gz (7.6 kB 查看哈希值)
构建分布
django_docs-0.3.3-py3-none-any.whl (8.7 kB 查看哈希值)