Documentation for json schema exporter

Summary

Adding jsex docs to the main documentation and enhancing the docstring.

Focus

Is this accurate? Sufficient?

Test Environment

make doc && xdg-open build/html/index.html

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 caosdb/customers/dimr/management#232
• Up-to-date CHANGELOG.md (or not necessary)
• Up-to-date JSON schema (or not necessary)
• Appropriate user and developer documentation (or not necessary)
  • How do I use the software? Assume "stupid" users.
  • How do I develop or debug the software? Assume novice developers.
• 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 (or not necessary)
• Appropriate user and developer documentation (or not necessary)
• 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 specifications? Are they satisfied?

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

assigned to @daniel

requested review from @florian

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

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

marked the checklist item All automated tests pass as completed

resolved all threads

marked the checklist item Up-to-date CHANGELOG.md (or not necessary) as completed

marked the checklist item Appropriate user and developer documentation (or not necessary) as completed

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

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

added 1 commit

• 8bb52471 - DOC: Update changelog

Compare with previous version

approved this merge request

enabled an automatic merge when the pipeline for 8bb52471 succeeds

mentioned in commit d17a6669

merged