Docsets for ReactiveCocoa

[antmd]

Hi,

I had some spare time, so I wrote a TomDoc to <OtherDocumentationFormat> converter, because I wanted a docset for ReactiveCocoa

I've added support for appledoc and Doxygen.
I haven't integrated it into the build process, because I'm not sure what your preferences are.

Appledoc

Example docset here: http://dervishsoftware.s3.amazonaws.com/software/com.github.ReactiveCocoa.docset.xip

copy to ~/Library/Developer/Shared/Documentation/DocSets

I made a couple of changes to appledoc to make it skip deprecated symbols, and to prevent it auto-linking to common English words (which are also RACSignal symbols)

An updated version of appledoc is here: https://github.com/antmd/appledoc

My pull request is: tomaz/appledoc#397

You can use the 'brew' version of appledoc, but you'll get extra spurious hyperlinks in the output. The script to generate documentation checks for the presence of the extra command-line options.

Generate command-line:

cd <ReactiveCocoaRoot>/ReactiveCocoaFramework/Scripts
./generate_docs.sh -s ../ReactiveCocoa -x ../../README.md -f ReactiveCocoa -c GitHub -d com.github

This will install the docset in ~/Library/Developer/Shared/Documentation/DocSets, and it will be available immediately in Xcode.

Doxygen

Doxygen output generates a folder 'html' in ~/Downloads

Generate command-line:

cd <ReactiveCocoaRoot>/ReactiveCocoaFramework/Scripts
./generate_docs.sh -s ../ReactiveCocoa -x ../../README.md -f ReactiveCocoa -c GitHub -d com.github -t doxygen

The doxygen output draws nice inheritance and collaboration diagrams.

Doxygen is supposed to be able to generate Apple DocSets, too, but I couldn't get it to work properly. I think it's a known issue.

[jspahrsummers]

Thanks for suggesting this! ✨

Unfortunately, I don't think we should be taking responsibility for maintaining this conversion process within ReactiveCocoa. If this got merged, it would appear as an official part of RAC, and we would be more or less obligated to provide fixes and improvements for it.

This seems more appropriate for a personal project. However, I'd be more than happy to link to it when asked about TomDoc generation!

[robb]

@orta may be interested in this, too

[orta]

I am, there's some value here in making the ReactiveCocoa experience on CocoaDocs work better, thanks @antmd - if this isn't merged, what license is it?

[antmd]

Hi Orta,

I’ve checked the scripts in to a separate repo: https://github.com/antmd/tomdoc-converter-objc. Let me know if it needs some more work for CocoaDocs.

I’m using the MIT license.

Best Regards
—Anthony

On 1 Sep 2013, at 16:34pm, Orta notifications@github.com wrote:

I am, there's some value here in making the ReactiveCocoa experience on CocoaDocs work better, thanks @antmd - if this isn't merged, what license is it?

—
Reply to this email directly or view it on GitHub.

[antmd]

Closing.