Re: Video: Generating Beautiful (and Correct) Documentation from Unit Tests Files
Thanks Matt! Yes it does! Please give it a go. I would love to see some examples of more generated readmes On 27/09/2013, at 1:39, Matt Mitchell wrote: > Very nice! Does lein-midje-doc use the Midje fact(s) labels? > > - Matt > > On Wednesday, September 25, 2013 10:33:31 PM UTC-4, zcaudate wrote: >> >> I've put up a video of a new documentation plugin for leiningen >> >> Project Page: >> https://github.com/zcaudate/lein-midje-doc >> >> Youtube Video: >> http://www.youtube.com/watch?v=8FjvhDPIUWE&feature=youtu.be >> >> >> Sample Generated Documentation: >> http://z.caudate.me/lein-midje-doc/ >> http://z.caudate.me/ribol/ >> http://z.caudate.me/ova/ >> >> >> Any Comments or Feedback would be appreciated > > -- > -- > You received this message because you are subscribed to the Google > Groups "Clojure" group. > To post to this group, send email to clojure@googlegroups.com > Note that posts from new members are moderated - please be patient with your > first post. > To unsubscribe from this group, send email to > clojure+unsubscr...@googlegroups.com > For more options, visit this group at > http://groups.google.com/group/clojure?hl=en > --- > You received this message because you are subscribed to a topic in the Google > Groups "Clojure" group. > To unsubscribe from this topic, visit > https://groups.google.com/d/topic/clojure/JBCGLK5gpF8/unsubscribe. > To unsubscribe from this group and all its topics, send an email to > clojure+unsubscr...@googlegroups.com. > For more options, visit https://groups.google.com/groups/opt_out. -- -- You received this message because you are subscribed to the Google Groups "Clojure" group. To post to this group, send email to clojure@googlegroups.com Note that posts from new members are moderated - please be patient with your first post. To unsubscribe from this group, send email to clojure+unsubscr...@googlegroups.com For more options, visit this group at http://groups.google.com/group/clojure?hl=en --- You received this message because you are subscribed to the Google Groups "Clojure" group. To unsubscribe from this group and stop receiving emails from it, send an email to clojure+unsubscr...@googlegroups.com. For more options, visit https://groups.google.com/groups/opt_out.
Re: Video: Generating Beautiful (and Correct) Documentation from Unit Tests Files
Hi Ben! Thanks for the feedback! I have thought about how this feature may be implemented. I've got some ideas but a little short on time... With what you are saying, The autodoc feature has to be built into the library as well. To generate an index of functions, one can use a tag of some kind... ie.. :autodoc You can then tag each fact, or piece of code with the function that it it for, then when the function is being generated, it will spit out the relevant tagged samples into the document. this current version is a hack and needs to be rewritten... Collaborators would be most welcome! On 27/09/2013, at 2:21, Ben Mabey wrote: > On 9/25/13 8:33 PM, zcaudate wrote: >> I've put up a video of a new documentation plugin for leiningen >> >> Project Page: >> https://github.com/zcaudate/lein-midje-doc >> >> Youtube Video: >> http://www.youtube.com/watch?v=8FjvhDPIUWE&feature=youtu.be >> >> >> Sample Generated Documentation: >> http://z.caudate.me/lein-midje-doc/ >> http://z.caudate.me/ribol/ >> http://z.caudate.me/ova/ >> >> >> Any Comments or Feedback would be appreciated > > > This library looks great Chris! I can't wait to put it to use. :) > > It seems like the goal of this project is aimed at high level documentation > like you find in READMEs. That said, have you considered yet how to > incorporate similar ideas into lower level API documentation? For example, > API documentation generated by tools like Autodoc could be augmented with > midje facts that have been tagged to be examples for a particular function. > > Thanks for the great library! > > -Ben > > -- > -- > You received this message because you are subscribed to the Google > Groups "Clojure" group. > To post to this group, send email to clojure@googlegroups.com > Note that posts from new members are moderated - please be patient with your > first post. > To unsubscribe from this group, send email to > clojure+unsubscr...@googlegroups.com > For more options, visit this group at > http://groups.google.com/group/clojure?hl=en > --- You received this message because you are subscribed to a topic in the > Google Groups "Clojure" group. > To unsubscribe from this topic, visit > https://groups.google.com/d/topic/clojure/JBCGLK5gpF8/unsubscribe. > To unsubscribe from this group and all its topics, send an email to > clojure+unsubscr...@googlegroups.com. > For more options, visit https://groups.google.com/groups/opt_out. -- -- You received this message because you are subscribed to the Google Groups "Clojure" group. To post to this group, send email to clojure@googlegroups.com Note that posts from new members are moderated - please be patient with your first post. To unsubscribe from this group, send email to clojure+unsubscr...@googlegroups.com For more options, visit this group at http://groups.google.com/group/clojure?hl=en --- You received this message because you are subscribed to the Google Groups "Clojure" group. To unsubscribe from this group and stop receiving emails from it, send an email to clojure+unsubscr...@googlegroups.com. For more options, visit https://groups.google.com/groups/opt_out.
Re: Video: Generating Beautiful (and Correct) Documentation from Unit Tests Files
On 9/25/13 8:33 PM, zcaudate wrote: I've put up a video of a new documentation plugin for leiningen Project Page: https://github.com/zcaudate/lein-midje-doc Youtube Video: http://www.youtube.com/watch?v=8FjvhDPIUWE&feature=youtu.be Sample Generated Documentation: http://z.caudate.me/lein-midje-doc/ http://z.caudate.me/ribol/ http://z.caudate.me/ova/ Any Comments or Feedback would be appreciated This library looks great Chris! I can't wait to put it to use. :) It seems like the goal of this project is aimed at high level documentation like you find in READMEs. That said, have you considered yet how to incorporate similar ideas into lower level API documentation? For example, API documentation generated by tools like Autodoc could be augmented with midje facts that have been tagged to be examples for a particular function. Thanks for the great library! -Ben -- -- You received this message because you are subscribed to the Google Groups "Clojure" group. To post to this group, send email to clojure@googlegroups.com Note that posts from new members are moderated - please be patient with your first post. To unsubscribe from this group, send email to clojure+unsubscr...@googlegroups.com For more options, visit this group at http://groups.google.com/group/clojure?hl=en --- You received this message because you are subscribed to the Google Groups "Clojure" group. To unsubscribe from this group and stop receiving emails from it, send an email to clojure+unsubscr...@googlegroups.com. For more options, visit https://groups.google.com/groups/opt_out.
Re: Video: Generating Beautiful (and Correct) Documentation from Unit Tests Files
Very nice! Does lein-midje-doc use the Midje fact(s) labels? - Matt On Wednesday, September 25, 2013 10:33:31 PM UTC-4, zcaudate wrote: > > I've put up a video of a new documentation plugin for leiningen > > Project Page: > https://github.com/zcaudate/lein-midje-doc > > Youtube Video: > http://www.youtube.com/watch?v=8FjvhDPIUWE&feature=youtu.be > > > Sample Generated Documentation: > http://z.caudate.me/lein-midje-doc/ > http://z.caudate.me/ribol/ > http://z.caudate.me/ova/ > > > Any Comments or Feedback would be appreciated > -- -- You received this message because you are subscribed to the Google Groups "Clojure" group. To post to this group, send email to clojure@googlegroups.com Note that posts from new members are moderated - please be patient with your first post. To unsubscribe from this group, send email to clojure+unsubscr...@googlegroups.com For more options, visit this group at http://groups.google.com/group/clojure?hl=en --- You received this message because you are subscribed to the Google Groups "Clojure" group. To unsubscribe from this group and stop receiving emails from it, send an email to clojure+unsubscr...@googlegroups.com. For more options, visit https://groups.google.com/groups/opt_out.
Video: Generating Beautiful (and Correct) Documentation from Unit Tests Files
I've put up a video of a new documentation plugin for leiningen Project Page: https://github.com/zcaudate/lein-midje-doc Youtube Video: http://www.youtube.com/watch?v=8FjvhDPIUWE&feature=youtu.be Sample Generated Documentation: http://z.caudate.me/lein-midje-doc/ http://z.caudate.me/ribol/ http://z.caudate.me/ova/ Any Comments or Feedback would be appreciated -- -- You received this message because you are subscribed to the Google Groups "Clojure" group. To post to this group, send email to clojure@googlegroups.com Note that posts from new members are moderated - please be patient with your first post. To unsubscribe from this group, send email to clojure+unsubscr...@googlegroups.com For more options, visit this group at http://groups.google.com/group/clojure?hl=en --- You received this message because you are subscribed to the Google Groups "Clojure" group. To unsubscribe from this group and stop receiving emails from it, send an email to clojure+unsubscr...@googlegroups.com. For more options, visit https://groups.google.com/groups/opt_out.
