django sphinx automodule —基础知识
作者：互联网
我有一个包含多个大型应用程序的项目,其中的设置和应用程序文件被拆分.
目录结构是这样的：
项目名
> __init__.py
>应用
> __init__.py
> app1
> app2
>第三党
> __init__.py
> lib1
> lib2
>设置
> __init__.py
> installed_apps.py
> path.py
> templates.py
> locale.py
> …
> urls.py
每个应用都是这样
> __init__.py
>管理员
> __init__.py
> file1.py
> file2.py
>型号
> __init__.py
> model1.py
> model2.py
>测试
> __init__.py
> test1.py
> test2.py
>意见
> __init__.py
> view1.py
> view2.py
> urls.py
如何使用狮身人面像为此自动生成文档？
我想要这样的东西
对于设置模块或INSTALLED_APPS中的每个模块(不是以django.*或3rdparty.*开头),给我一个基于docstring的自动文档输出
和自动生成文档并在git commit之前运行测试
顺便说一句
我尝试手动处理.rst文件
.. automodule:: module_name
:members:
但是对于这么大的项目来说很糟糕,
而且不适用于设置
有自动生成方法吗？
我不受狮身人面像的束缚,是否有更好的解决方案来解决我的问题？
解决方法:
>参见Automatically Generating Documentation for All Python Package Contents.
>即将发布的Sphinx 1.1版本包含sphinx-apidoc.py脚本.
标签：python-sphinx,python,django,documentation 来源： https://codeday.me/bug/20191208/2092852.html