Included files do not show up on rubydoc.info but do locally

[michaelklishin]

I just refreshed ruby-amqp/amqp documentation on rubydoc.info and all the included examples in this guide are not displayed. They do show up locally, through. I tried to rm -rf doc and restarted YARD server just in case, but to no avail.

Is this a rubydoc.info setup issue or am I doing something wrong?

[michaelklishin]

This also affects other guides, including Getting Started :( How can I help with investigating the issue?

[lsegal]

If it only happens on rubydoc.info, it's a rubydoc.info issue. We have support tickets on the site. That said, what do you mean by not being displayed? All of those links work for me...

[michaelklishin]

There are embedded examples that use include:file:. They are not displayed.

[michaelklishin]

I understand what is going on now: I use file paths repative to repository root. rubydoc.info sets up --docroot explicitly.

Given that my directory layout is this:

• docs/GettingStarted.textile
• examples/guides/getting_started/01_hello_world.rb

how do I reference that example from the guide? (without knowing what the --docroot is, of course) Is there any way to do "relative to this file" kind of addressing? I will switch back to embedded gists now, it is sad that such a great feature cannot really be used without knowing docroot of the YARD server.

[lsegal]

Includes should be relative to the root of your projects. {include:file:examples/guides/getting_started/01_hello_world.rb}

[michaelklishin]

That's exactly what I used, for example. It worked fine locally and didn't render examples on rubydoc.info. I replaced all the examples with embedded gists for now, but will try to switch a couple back to include:file: and post an update here.

[lsegal]

The examples/ directory is likely getting deleted, since we clear out all unused source files to save space on a checkout. Open a support ticket on rubydoc.info since this is an issue with the site, not yard.

[michaelklishin]

Agreed. By support ticket do you mean an issue in the rubydoc.info github project?

[lsegal]

That works too

[michaelklishin]

Done