DOC: code gallery

Summary

New code gallery section in documentation, with one example.

Focus

• Is this a viable starting point for more examples?
• Does the documentation compile?
• Does the example run and produce the desired result?

Test Environment

Documentation

1. make doc
2. Open html in browser xdg-open build/doc/html/index.html

Example code

1. Start empty CaosDB instance.
2. cd src/doc/gallery/
3. make test

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 #82 (closed)
• Up-to-date CHANGELOG.md
• Add type hints in created/changed code
• 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.

assigned to @daniel

marked the checklist item All automated tests pass as completed

marked the checklist item Add type hints in created/changed code as completed

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

marked the checklist item Add type hints in created/changed code as incomplete

assigned to @florian

added 1 commit

• ab4955d9 - STY: autopep'd

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

resolved all threads

added 2 commits

• 9a165f6a - 1 commit from branch dev
• 3ce130d4 - Merge branch 'dev' into f-doc-code-gallery

Compare with previous version

approved this merge request

enabled an automatic merge when the pipeline for 3ce130d4 succeeds

mentioned in commit c1e87dc6

merged