Add complete documentation for Nagra ORM library

[hugodendievelb12]

Provide comprehensive documentation to enhance understanding and usage of the Nagra ORM library.

[Copilot]

Copilot reviewed 1 out of 1 changed files in this pull request and generated no comments.

[swertz]

This is very nice, thanks! I suggest that we use sphinx (or equivalent) to generate the documentation. It could then be automatically updated and uploaded through a github CI action.

This way you can write the method-specific documentation as docstrings in the code, rather than packing everything in a single file. The rest could then also be structured in separate pages.

Let me know if you need pointers for this.

[bertrand-chenal]

I did not read all of it, but I spotted several errors.
I think atm we need to add 2 type of doc:

• Docstrings on classes and methods to explain behavior.
• Guides on how to solve particular problem (based on feedback from new users)

I'm also used to work with pydoc which is plug and play, it generate something like this: https://bertrandchenal.github.io/lakota/