Tidying documentation into sections

[GernotMaier]

The number of files in docs/sources increased over the past months significantly (which is good!). But this makes it a bit hard to get an overview and one gets easily lost finding the correct documentation file.

This PR addresses this issue and introduces a typical organisation as found in most python projects (and also in e.g. ctapipe) with main sections for

• user guide
• API doc
• developer guide

No content has been changed. As a reviewer you have to agree/disagree with this reorganisation and that's it.

[ctao-dpps-sonarqube[bot]]

Analysis Details

0 Issues

• 0 Bugs
• 0 Vulnerabilities
• 0 Code Smells

Coverage and Duplications

• No coverage information (72.90% Estimated after merge)
• No duplication information (0.10% Estimated after merge)

Project ID: gammasim_simtools_AY_ssha9WiFxsX-2oy_w

View in SonarQube

[GernotMaier]

Wait, what about this one: https://github.com/gammasim/simtools/blob/tidying-documentation/docs/source/api-reference/index.md ?

[VictorBarbosaMartins]

Wait, what about this one: https://github.com/gammasim/simtools/blob/tidying-documentation/docs/source/api-reference/index.md ?

ok, I missed that.