django笔记（十四）使用sphinx 创建django文档

1.安装sphinx以及使用

win10 虚拟环境

直接执行会报错拒绝访问

使用管理员执行cmd进入工程根目录执行

sphinx-quickstart

会自动创建build目录

执行sphinx-apidoc -o source .

或

sphinx-apidoc -o source ./myapp

先修改conf.py文件

import os

import sys

sys.path.insert(0, os.path.abspath('../'))

import django

os.environ['DJANGO_SETTINGS_MODULE'] = 'proc.settings'

以及增加

extensions = ['sphinx.ext.todo', 'sphinx.ext.viewcode', 'sphinx.ext.autodoc']

然后执行

make.bat html

会在build/html目录生成htm文档

2.文档集成到django

SPHINX_DOCS_ROOT = os.path.join(BASE_DIR, 'build', 'html')

from django.conf import settings

from django.views.static import serve

路由修改

re_path(r'^sphinx_docs/(?P<path>.*)$', serve, {'document_root': settings.SPHINX_DOCS_ROOT}),

re_path(r'^sphinx_docs/', serve, {'document_root': settings.SPHINX_DOCS_ROOT, 'path': 'index.html'}),

重新make

3安装新主题

pip install sphinx_rtd_theme

修改conf.py

import sphinx_rtd_theme

html_theme = "sphinx_rtd_theme"

html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

再次make html

访问

http://127.0.0.1:8001/sphinx_docs/index.html

页面看着很舒服

image.png