Skip to content

Setup documentation system

Summary

The code should be properly documented both from the API and user story points of view.

What is the expected correct behavior?

Proposal: sphinx-based documentation on read-the-docs template for API documentation plus jupyter notebooks for user stories. The documentation has to be built automatically with CI and published on a dedicated web server. (CERN-provided project webpage is a good candidate)

Relevant logs and/or screenshots