Skip to content

autogenerated API docs

Jonas Eschle requested to merge auto_apidoc into master

Automatically generated API documentation with Sphinx.

The docs can be generated with the make_docs.sh script in the folder docs. The html output can be seen in docs/api/_build/html (and renders nicely in a browser). The theme and layout can be changed of course (although the layout can be difficult and themes aren't a lot of good ones available I think.

We could include them like this or even host them somewhere (CERN website, at least for test?) if wanted. Another format (LaTex, epub) is possible as well.

Of course, the whole thing can be extended by the README files. But that's another step.

What do you think @apuignav ?

Edited by Jonas Eschle

Merge request reports