Generate feeds for Dash docset #307

Open
bjtitus opened this Issue Jan 31, 2013 · 5 comments

Comments

Projects
None yet
2 participants
@bjtitus
Contributor

bjtitus commented Jan 31, 2013

Add an option to generate Dash docsets. Maybe there could be a command line flag allowing multiple feed formats to be set?

I would be more than willing to implement this if anyone can give me some direction on how it might work for users.

@tomaz

This comment has been minimized.

Show comment
Hide comment
@tomaz

tomaz Feb 1, 2013

Owner

This should be working out of the box as long as you're targeting objective c - see #217. Basically Dash since version 1.6.5 looks for presence of a special key inside info.plist file of generated docset. By default appledoc puts appledoc as the value of that key, but you can control the value through --dash-platform-family cmd line switch (not sure if that would change anything though, don't think so AFAIK).

If you're generating docset for other languages, then you must look at different generator as appledoc only supports objc at this point.

Owner

tomaz commented Feb 1, 2013

This should be working out of the box as long as you're targeting objective c - see #217. Basically Dash since version 1.6.5 looks for presence of a special key inside info.plist file of generated docset. By default appledoc puts appledoc as the value of that key, but you can control the value through --dash-platform-family cmd line switch (not sure if that would change anything though, don't think so AFAIK).

If you're generating docset for other languages, then you must look at different generator as appledoc only supports objc at this point.

@tomaz tomaz closed this Feb 1, 2013

@bjtitus

This comment has been minimized.

Show comment
Hide comment
@bjtitus

bjtitus Feb 1, 2013

Contributor

Sorry, I was a little too ambiguous in my title.

I was referring to the generation of the feeds. Currently, publishing an appledoc generates an Xcode-ready atom feed. I was thinking it would be nice to generate the Dash-ready xml feed.

Contributor

bjtitus commented Feb 1, 2013

Sorry, I was a little too ambiguous in my title.

I was referring to the generation of the feeds. Currently, publishing an appledoc generates an Xcode-ready atom feed. I was thinking it would be nice to generate the Dash-ready xml feed.

@tomaz

This comment has been minimized.

Show comment
Hide comment
@tomaz

tomaz Feb 2, 2013

Owner

Oh I see. This would be nice addition, will mark it as feature requesf. Probably won't come to it until 3.0.

Owner

tomaz commented Feb 2, 2013

Oh I see. This would be nice addition, will mark it as feature requesf. Probably won't come to it until 3.0.

@tomaz tomaz reopened this Feb 2, 2013

bjtitus added a commit to bjtitus/appledoc that referenced this issue Feb 6, 2013

Adding support for generating Dash's xml format #307
This is some initial support for adding Dash xml feed generation. Note that support for specifying formats is a little crude and I've added a template for xml files which I think is a reasonable approach.
@bjtitus

This comment has been minimized.

Show comment
Hide comment
@bjtitus

bjtitus Feb 6, 2013

Contributor

Sorry I cluttered up this issue. Didn't realize rebasing would show this commit so many times.

Contributor

bjtitus commented Feb 6, 2013

Sorry I cluttered up this issue. Didn't realize rebasing would show this commit so many times.

@tomaz

This comment has been minimized.

Show comment
Hide comment
@tomaz

tomaz Feb 7, 2013

Owner

Don't worry :)

Owner

tomaz commented Feb 7, 2013

Don't worry :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment