rdoc.info doesn't accept #:nodoc: directive?

's Avatar


27 Dec, 2010 06:41 PM

It appears that rdoc.info is ignoring #:nodoc: directives. For example, I have a module "ClassMethods" inside my memories project marked as "#:nodoc: all", with a few methods inside of it marked with the ":doc:" directive. Both ClassMethods and all methods inside of it show up on the memories rdoc.info page.

  1. Support Staff 1 Posted by lsegal on 28 Dec, 2010 03:22 AM

    lsegal's Avatar

    Hi there,

    Rubydoc.info uses YARD to generate documentation. YARD does not support directives, and specifically does not support :nodoc:. You can see https://github.com/lsegal/yard/issuesearch#issue/11 for a discussion and some ways to do this the "yard way".



  2. lsegal closed this discussion on 11 Jan, 2011 08:39 AM.

Comments are currently closed for this discussion. You can start a new one.

Keyboard shortcuts


? 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