DOC: Add sections to documentation

Summary

See https://gitlab.indiscale.com/caosdb/customers/lfpb/management/-/issues/409. Add sections, placeholders for examples, and automatically generated docs to the documentation.

Focus

Verify that the structure makes sense.

Test Environment

Build the documentation as described in README_SETUP.md

Check List for the Author

Please, prepare your MR for a review. Be sure to write a summary and a focus and create gitlab comments for the reviewer. They should guide the reviewer through the changes, explain your changes and also point out open questions. For further good practices have a look at our review guidelines

• All automated tests pass
• Reference related Issues
• [ ] Up-to-date CHANGELOG.md
• Annotations in code (Gitlab comments)
  • Intent of new code
  • Problems with old code
  • Why this implementation?

Check List for the Reviewer

• I understand the intent of this MR
• All automated tests pass
• [ ] Up-to-date CHANGELOG.md
• The test environment setup works and the intended behavior is reproducible in the test environment
• In-code documentation and comments are up-to-date.
• Check: Are there spezifications? Are they satisfied?

For further good practices have a look at our review guidelines.

marked the checklist item All automated tests pass as completed

marked the checklist item Reference related Issues as completed

marked the checklist item Annotations in code (Gitlab comments) as completed

added 1 commit

• d1a34972 - DOC: Add repo url

Compare with previous version

marked the checklist item I understand the intent of this MR as completed

marked the checklist item All automated tests pass as completed

marked the checklist item The test environment setup works and the intended behavior is as completed

marked the checklist item In-code documentation and comments are up-to-date. as completed

marked the checklist item Check: Are there spezifications? Are they satisfied? as completed

resolved all threads

merged

mentioned in commit e3fcf8fe