Create generated documentation for the Pact Broker classes

[bethesque]

RDoc would be the preference, unless there is a good reason to try something else.

http://rdoc.sourceforge.net/

[bangn]

If you are looking for an alternative Yardoc is the one. It has blessing words from Mike Perham creator of sidekiq as well :D https://www.mikeperham.com/2010/12/16/using-rdoc/

In the meantime I'll look into generating the doco with RDoc.

I guess we would only want to generate RDoc for pact_broker/lib/pact_broker, wouldn't we?

[bethesque]

note the support for Markdown-formatted README files, which RDoc does not have

Having markdown would be great. I think it's worth looking at Yardoc then.

There are a few other modules in that top level, so I'd say pact_broker/lib/