integration: add ModuleDoc and AutoDoc
authorSean Cross <sean@xobs.io>
Tue, 24 Sep 2019 06:30:28 +0000 (14:30 +0800)
committerSean Cross <sean@xobs.io>
Tue, 24 Sep 2019 06:30:28 +0000 (14:30 +0800)
commit131971986c56d92b963e374d1fc416f9771e0274
tree39a59d46b9b5f526c00326a64f0cede0daa5eb50
parent8b7d8217a0ea858119d37e45988837e05d25bba7
integration: add ModuleDoc and AutoDoc

It is important to be able to document modules other than CSRs.
This patch adds ModuleDoc and AutoDoc, both of which can be used
together to document modules.

ModuleDoc can be used to transform the __doc__ string of a class into a
reference-manual section.  Alternately, it can be used to add additional
sections to a module.

AutoDoc is used to gather all submodule ModuleDoc objects in order to
traverse the tree of documentation.

Signed-off-by: Sean Cross <sean@xobs.io>
litex/soc/integration/doc.py [new file with mode: 0644]