1

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

具体来说,除了常规生成的自动文档文档之外,我希望文档中的页面提供所有...

  • 楷模
  • 中间件
  • 意见
  • 上下文处理器
  • 信号
  • 测试用例

来自典型的应用程序结构,例如

├── 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

和一个(据说)文档字符串

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 来做我想做的事吗?你会建议一些其他的方法来得到这个吗?或者是手动完成这一切的唯一方法?

4

1 回答 1

0

如何使用子存储库?您可以创建一个新项目,其中子存储库myappotherappdoc 目录平行:

doc_proj/
   build/
   Makefile
   source/
   myapp/    (subrepository)
   otherapp/ (subrepository)
于 2013-06-13T23:16:57.260 回答