Interactive documentation

Question

Transform the code snippets of the test.check documentation into interactive code snippets using the codox klipse theme.

Answer 1

Comment made by: viebel

This is the patch for interactive documentation using codox klipse theme https://github.com/viebel/codox-klipse-theme
Live demo of the result:

http://viebel.github.io/klipse/examples/test.check/doc/intro.html

http://viebel.github.io/klipse/examples/test.check/doc/generator-examples.html

http://viebel.github.io/klipse/examples/test.check/doc/clojure.test.check.html#var-quick-check

Will add interactive snippets to the other functions later.

Answer 2

Comment made by: gfredericks

Would this require having klipse annotations in the docstrings of all the functions we'd want to include?

Answer 3

Comment made by: viebel

Yes.

Answer 4

Comment made by: viebel

Updated the patch with changes only in project.clj
Now, we don't have to include the klipse annotations in the docstrings.
The interactive doc is opt-out - there is a link in the top of the page to activate it.

Answer 5

Comment made by: alex+import

Added attachment lost in the migration.

Answer 6

Reference: https://clojure.atlassian.net/browse/TCHECK-123 (reported by viebel)