tag:rubydoc.tenderapp.com,2010-12-26:/discussions/problems/496-includefile-not-workingRubydoc.info: Discussion 2016-12-01T11:19:02Ztag:rubydoc.tenderapp.com,2010-12-26:Comment/413635662016-11-30T19:57:29Z2016-11-30T19:57:29Z{include:file:} not working<div><p>You can only include "extra files" (see <a href="http://www.rubydoc.info/gems/yard/file/docs/GettingStarted.md#Documenting_Extra_Files">
the documentation</a> for this feature), namely files that are
marked in your .yardopts as text documents. Rubydoc.info deletes
all source files after parsing to save disk space, so while include
might work locally, it won't work on the site.</p>
<p>Hope that helps!</p></div>lsegaltag:rubydoc.tenderapp.com,2010-12-26:Comment/413635662016-12-01T06:43:12Z2016-12-01T06:43:13Z{include:file:} not working<div><p>After adding the Ruby files in .yardopts they show up in YARD's
file list, but still are not embedded.</p>
<p>I guess I have to serve the docs from GitHub somehow.<br>
Thanks!</p></div>furunkeltag:rubydoc.tenderapp.com,2010-12-26:Comment/413635662016-12-01T07:47:28Z2016-12-01T07:47:28Z{include:file:} not working<div><p>The feature should be working correctly on rubydoc.info. Have
you tested this locally in YARD to verify that you've configured
everything correctly?</p></div>lsegaltag:rubydoc.tenderapp.com,2010-12-26:Comment/413635662016-12-01T07:55:51Z2016-12-01T07:55:53Z{include:file:} not working<div><p>Yeah, it's working locally. I've now added the folder that
contains the Ruby files into .yardopts. If I run yardoc locally, it
complains:<br>
[warn]: Could not find extra file: docs/examples Ruby files are not
listed under "Files", neither do includes work.<br>
What struck me as odd, however, is that now links to the image
files in docs/examples work (so even though giving a warning, the
line has an effect), and what's more, I can access the Ruby files
(rendered as HTML) if I append examples/file.rb to the URL, so the
files somehow are there, but {include:file:} refuses to include
them.</p></div>furunkeltag:rubydoc.tenderapp.com,2010-12-26:Comment/413635662016-12-01T07:59:46Z2016-12-01T07:59:46Z{include:file:} not working<div><p>Do you have a code example and/or a rubydoc URL so I can get a
sense of what you are seeing?</p></div>lsegaltag:rubydoc.tenderapp.com,2010-12-26:Comment/413635662016-12-01T08:05:04Z2016-12-01T08:05:08Z{include:file:} not working<div><p><a href="http://www.rubydoc.info/github/evoasm/evoasm/master/file/docs/Visualization.md">
http://www.rubydoc.info/github/evoasm/evoasm/master/file/docs/Visua...</a><br>
The images are there.<br>
This file contains {include:file:docs/examples/vis.rb} but it's not
included.<br>
The file is accessible as <a href="http://www.rubydoc.info/github/evoasm/evoasm/master/file/docs/examples/vis.rb">
http://www.rubydoc.info/github/evoasm/evoasm/master/file/docs/examp...</a>,
though.</p></div>furunkeltag:rubydoc.tenderapp.com,2010-12-26:Comment/413635662016-12-01T08:15:06Z2016-12-01T08:15:06Z{include:file:} not working<div><p>I think I see the problem.</p>
<p>Paths cannot be listed as directories in the extra files portion
of the yard doc command, you have to use globs if you want to
specify multiple files. Using <code>docs/examples/**/*</code>
should work.</p>
<p>Hope that helps!</p></div>lsegaltag:rubydoc.tenderapp.com,2010-12-26:Comment/413635662016-12-01T08:19:56Z2016-12-01T08:19:59Z{include:file:} not working<div><p>Ok, I'll try that. Thanks!</p></div>furunkeltag:rubydoc.tenderapp.com,2010-12-26:Comment/413635662016-12-01T11:19:01Z2016-12-01T11:19:02Z{include:file:} not working<div><p>Just to let you know, if I add a glob:<br>
* the Ruby files appear as stand-alone extra files in the file list
(which I don't want) * {include:file:} still does not work * YARD
tries to parse everything it finds, including binary image
files</p></div>furunkel