Generate and publish (and cross-link) API reference for packages #106
Description
I am opening this issue here, since this is where all of the documentation comes together at some point. I think we should start to generate API references for all or at least the most important packages in Key4hep and deploy them somewhere. We can then cross link to those pages from the main documentation.
The main question that should be answered first is: Please express opinions and thoughts below (otherwise, do-ocracy will do its thing, and we go with whatever gets done).
- What style do we want to have for the generated documentation? I think we should decide on one and then follow through with that style everywhere (that is under our control).
- We have read-the-docs style, e.g. for the main documentation, but also for podio, which also has a python and API reference in this style
- plain doxygen style, e.g. for EDM4hep
We should probably also come up with a list of repos that we want to prioritize in the beginning.