Skip to content

Building API documentation.

Daniel Hornung requested to merge release-f-apidoc into dev

Summary

MR for #111 (closed), builds API documentation now.

Focus

Building of the API documentation should work and be linked in the resulting HTML files.

Test Environment

Local make doc always worked, so the most important part is the pipeline building. Therefore, check if the resulting artifacts show the desired results. For example, load and extract the artifacts from https://gitlab.indiscale.com/caosdb/src/caosdb-crawler/-/jobs/214484 (the pages_prepare job).

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 #111 (closed)
  • 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.

Edited by Henrik tom Wörden

Merge request reports