Kamaelia is a toolset that had the aim of making working with concurrency simple and reusable. It is now retired in favour of Guild. (This is the definitive repository for kamaelia however)
After the various recent changes to enable this, this code forms the basis of a new approach to autogenerating the documentation for the site. For the moment it accepts the fact that the docs are RST rather than markdown - but it would be nice to switch to markdown or docbook.
What this does:
Takes a package entry point
Finds all the modules within it
Looks for all the components within those
Generates a documentation page based on the module __doc__ string, the components docstrings and other public names in the module
It combines these into one large RST file
It then generates an API reference file in the form of a PDF. (This step requires pandoc)
Currently that PDF is around 370 pages in length (very wide margins though!)
After the various recent changes to enable this, this code forms the basis of a new approach to autogenerating the documentation for the site. For the moment it accepts the fact that the docs are RST rather than markdown - but it would be nice to switch to markdown or docbook.
What this does:
__doc__string, the components docstrings and other public names in the moduleCurrently that PDF is around 370 pages in length (very wide margins though!)