Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

RubyDoc documentation is empty #228

Closed
jornvandebeek opened this issue Sep 23, 2014 · 10 comments
Closed

RubyDoc documentation is empty #228

jornvandebeek opened this issue Sep 23, 2014 · 10 comments
Assignees
Labels

Comments

@jornvandebeek
Copy link

It seems the RubyDoc documentation is not generated anymore, see http://rubydoc.info/github/orgsync/active_interaction

@tfausak tfausak added the bug label Sep 23, 2014
@tfausak tfausak self-assigned this Sep 23, 2014
@tfausak
Copy link
Collaborator

tfausak commented Sep 23, 2014

That's weird. We haven't changed anything about our integration. I can generate the YARD locally without issue.

@tfausak
Copy link
Collaborator

tfausak commented Sep 23, 2014

I created a ticket for this.

@AaronLasseigne
Copy link
Owner

Thanks for letting us know.

@zapnap
Copy link

zapnap commented Sep 23, 2014

Looks like this is most likely because of the markup provider / markup combination in your .yardopts:

--markup-provider rdoc
--markup markdown

This might be an incompatibility with the version of rdoc we're using / pinned on rubydoc. Any reason not to use redcarpet, ghm or a more popular markdown library?

@lsegal
Copy link

lsegal commented Sep 23, 2014

rubydoc.info doesn't support rdoc markdown. You can get a list of supported providers for each markup type here: https://github.com/lsegal/yard/blob/master/lib/yard/templates/helpers/markup_helper.rb#L23-L50

@tfausak
Copy link
Collaborator

tfausak commented Sep 23, 2014

Wait, what? It says :rdoc right here: https://github.com/lsegal/yard/blob/11e1930720105adc3e1c6b2a4e54ea55f238b5f2/lib/yard/templates/helpers/markup_helper.rb#L31.

And check out #27 for our rationale for using RDoc.

@lsegal
Copy link

lsegal commented Sep 24, 2014

Oh, oops! I forgot that we recently changed this. My bad. Unfortunately rubydoc.info doesn't use an rdoc version that is compatible with the RDoc markdown markup (it needs 4.x+ and we use 3.9.x) because of compat issues: https://github.com/lsegal/rubydoc.info/blob/master/Gemfile#L6

@AaronLasseigne
Copy link
Owner

Maybe we need to take another look at kramdown.

@tfausak tfausak closed this as completed in 2ad2a81 Nov 4, 2014
@tfausak
Copy link
Collaborator

tfausak commented Nov 5, 2014

It looks like 2ad2a81 didn't fix it: http://www.rubydoc.info/github/orgsync/active_interaction.

@tfausak tfausak reopened this Nov 5, 2014
@tfausak
Copy link
Collaborator

tfausak commented Nov 6, 2014

I created another ticket for this.

@tfausak tfausak closed this as completed Nov 6, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

5 participants