Documentation is not being generated

's Avatar

taylor

23 Sep, 2014 02:32 PM

The documentation for orgsync/active_interaction is not being generated by RubyDoc.info. We are tracking this issue at: https://github.com/orgsync/active_interaction/issues/228.

I have attached the locally-generated documentation. It was made with Ruby 2.0.0p451 and yard 0.8.7.4 on OS X 10.9.4 using bundle exec yard.

  1. Support Staff 1 Posted by nap on 23 Sep, 2014 11:15 PM

    nap's Avatar

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

    --markup-provider rdoc
    --markup markdown
    

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

  2. 2 Posted by Taylor Fausak on 24 Sep, 2014 12:32 AM

    Taylor Fausak's Avatar

    We prefer RDoc because it's the most compatible Markdown processor we could find. We considered others, including RedCarpet (which doesn't work with JRuby) and kramdown (which didn't generate the correct thing). Read more here: <https://github.com/orgsync/active_interaction/issues/27>.

Reply to this discussion

Internal reply

Formatting help / Preview (switch to plain text) No formatting (switch to Markdown)

Attaching KB article:

»

Already uploaded files

  • active_interaction.tar.bz2 63.8 KB

Attached Files

You can attach files up to 10MB

If you don't have an account yet, we need to confirm you're human and not a machine trying to post spam.

Keyboard shortcuts

Generic

? Show this help
ESC Blurs the current field

Comment Form

r Focus the comment reply box
^ + ↩ Submit the comment

You can use Command ⌘ instead of Control ^ on Mac