直接到重点，安装sphinx

easy_install sphinx

在安装的过程中，了解一下sphinx，简单来说是生成按照ReStructuredText格式文档，而sphinx提供自动根据代码生成ReStructuredText格式的工具。 依赖库有不少，在国内安装应该会比较慢，在装好之前先建个django项目。

django-admin.py startproject mydocs
cd mydocs
tree

没有意外的话，应该会看到 . |– manage.py -- mydocs |-- __init__.py |-- settings.py |-- urls.py – wsgi.py 1 directory, 5 files 如果sphinx安装好以后，就可以初始化sphinx的文件了

mkdir docs
cd docs
sphinx-quickstart
### 一堆提示，一堆y/n选择，填项目名称，项目版本，作者之类的，一个个填吧。
tree

OK.也是，没有意外的话，会看到 . |– _build |– conf.py |– index.rst |– make.bat |– Makefile |– _static `– _templates 3 directories, 4 files 这时候要编辑一下index.rst文件，添加一行内容，打开index.rst文件，找到有一行 :maxdepth: 2, 在下面添加 mydocs.rst(这个想项目的module名字)。 好了，接着写个脚本到项目的根目录，先回到项目的根目录，然后用编辑器建一个build_docs.sh脚本文件，并按照下面的内容编辑

#!/usr/bin/env bash                                                             
# django的配置模块
export DJANGO_SETTINGS_MODULE="mydocs.settings"
# 项目的路径
export PYTHONPATH=`dirname "$(readlink -f "$0")"`
# 输出的路径
OUT_DIR=docs
# 生成代码的文档
sphinx-apidoc -o $OUT_DIR -f $PYTHONPATH
# 生成html格式的文档
( cd $OUT_DIR && make html )

先测试一下，是否可以运行

chmod +x build_docs.sh
./build_docs.sh

好了，编辑个代码看看，编辑mydocs/models.py。 [python]

-- coding: utf-8 --

“”” 测试文档用的models

“”” from django.db import models class User(models.Model): “”“用户类”“” username = models.CharField() “”“用户名”“” password = models.CharField() “”“密码”“” [/python] 到最后了，运行以下脚本，完成任务

./build_docs.sh
chromium-browser docs/_build/html/mydocs.html

运气好的话，就可以看到文档了