Add basics API reference

[SimonHeybrock]

This is not 100% complete as we are still working on a more user-friendly solution in some cases, but these are the most important bits.

[nvaytet]

Is there a way we can improve the long function names? Maybe only have the function name and not the submodule path? But I guess that path is important information to have...

[SimonHeybrock]

I suppose we can shorten, beam_center_finder -> beam_center, or remove the duplicate beam_center_ prefix from the 2 finders?

[nvaytet]

remove the duplicate beam_center_ prefix from the 2 finders?

would work in this case. But I guess it won't save us from future functions with long names.

[SimonHeybrock]

Maybe having shorter module names is good style generally. Should we just rename beam_center_finder -> beam?

After all, PEP8 says: "Modules should have short, all-lowercase names. Underscores can be used in the module name if it improves readability."

[nvaytet]

Or beamcenter? I feel beam is a little too vague?

[SimonHeybrock]

I suggest we keep it for now. We should probably sit down with Wojciech to review all the naming in the repo.

[nvaytet]

Was it intentional that some entries are under "Module attributes" while others are under "Classes"? I don't really seem to get the logic separating the two sections.

[SimonHeybrock]

It is not intentional, but this is what we get from the generic template, and due to the fact that some domain types are using NewType while others are not (are actual classes). I don't know how to fix that. Maybe the template could be rewritten?