如何根据Sphinx中的类别生成（autodoc）页面？

Question

我目前正在评估Sphinx的Django项目文档。它由紧密耦合到项目中的多个应用程序组成。我想要完成的一件事是生成按类别分组的文档页面。我可以手动完成所有这些操作，但我希望这可以自动完成。

具体来说，除了常规生成的autodoc文档之外，我还希望文档中的页面提供所有内容的概述...

• 模型
• 中间件
• 视图
• 上下文处理器
• 信号
• 测试用例

来自典型的应用结构，如

├── myapp
│   ├── forms.py
│   ├── __init__.py
│   ├── models.py
│   ├── templates
│   │   └── sometemplate.html
│   ├── tests.py
│   ├── urls.py
│   └── views.py
└── otherapp
    ├── context_processors.py
    ├── __init__.py
    ├── middleware.py
    ├── models.py
    ├── someotherfile.py
    ├── signals.py
    ├── templates
    │   └── othertemplate.html
    └── tests.py

和（据说）docstring

class MyView(View):
    """Displaying ...

    Some info about this View.

    .. category::
       django_view

    """

在

等文档中呈现

  

视图

     

myapp。views。MyView

     

    

有关此视图的一些信息。

  

     

otherapp。views。OtherView

     

    

有关此OtherView的一些信息。

  

我发现django-sphinx-autodoc可能会对浏览应用程序有所帮​​助。我应该扩展/修改django-sphinx-autodoc来做我想要的吗？你会建议其他方法来获得这个吗？或者只是手动完成这一切？

Answer 1

如何使用子存储库？您可以创建一个新项目，其中myapp和otherapp将是与doc目录平行的子存储库：

doc_proj/
   build/
   Makefile
   source/
   myapp/    (subrepository)
   otherapp/ (subrepository)