Reorganize & spruce up documentation #504
Description
Summary
We have quite a bit of documentation in the PTB, but sometimes it's not clear to users where to look for answers. Additionally, as the PTB has grown, we might have missed some neat additions. This issue is to investigate the current structure & then propose changes to move it towards a more ideal setup:
Some initial ideas are:
- Move features
Uniform Project Layoutto a more appropriate spot - Each of the sections below "Integrating Exasol-Toolbox into your Project" Should go on a separate page?
- Project configuration for nox needed (step 3 & 5) -> Using nox (?)
- Configure tooling (step 4)
- Formatting (step 6 + more)
- Documentation (step 7) & consolidate with links:x in https://exasol.github.io/python-toolbox/main/user_guide/ & customization.html & https://exasol.github.io/python-toolbox/main/developer_guide/modules/sphinx/sphinx.html
- Sonar
- Get rid of https://exasol.github.io/python-toolbox/main/developer_guide/modules/modules.html
- Page Metrics should mention Sonar and provide a link to the settings?
- Creating a Release should be moved from developer guide to the user guide
- API reference could be removed? -> remove as empty & changes would be in user guid
- Not sure about style guide -> remove as not specific to PTB
- Issue Tracking Guide -> remove as not specific to PTB