Documentation

Summary

Minimal documentation is written now and shows up on docs.indiscale.com.

Focus

• Is the documentation correct and complete?
• Is the minimal example enough for users to get started?
• Is it acceptable that the API documentation is outside sphinx?

Test Environment

• Build: make doc_clean; make doc
• Open the html: xdg-open build/doc/html/index.html
• To test the pages build: download the artifact directory from the pipeline, extract it and inspect the index.html inside.

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 -> integration test is allowed to fail since no corresponding repo exists there.
• Reference related Issues: for caosdb/customers/lfpb/management#417
• 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.

TODO

• Add description to README_SETUP.md: how to run unit tests locally

Makefile

@@ -31,7 +31,7 @@ help:
 
 .PHONY: doc
 doc:
-	cd doc && $(MAKE) html
+	$(MAKE) -C doc html
 
 ###############################################################################
 #                                   Styling                                   #
@@ -122,3 +122,14 @@ dist/caosdb.tar.gz: dist/
 .PHONY: dist/
 dist/:
 	mkdir -p dist
+
+###############################################################################
+#                                   Cleaning                                  #
+###############################################################################
+
+clean: doc_clean
+.PHONY: clean
+
+doc_clean:
+	rm -r doc/_build_octave/ build/doc/ NEWS || true
+.PHONY: doc_clean