tag:rubydoc.tenderapp.com,2010-12-26:/discussions/problems/302-homebrew-docs-dont-match-local-outputRubydoc.info: Discussion 2018-10-19T03:09:10Ztag:rubydoc.tenderapp.com,2010-12-26:Comment/349942982014-10-19T14:34:09Z2014-10-19T14:34:09ZHomebrew docs don't match local output<div><p>There was a stuck cache issue that I addressed this morning
(cache invalidation logic). Looks like the docs are updating now.
Let me know if that output doesn't look right or if this happens
again. I'll be working on overhauling our caching strategy soon,
apologies for the inconvenience.</p></div>naptag:rubydoc.tenderapp.com,2010-12-26:Comment/349942982014-10-19T14:43:55Z2014-10-19T14:43:56ZHomebrew docs don't match local output<div><p>Still doesn't look right to me I'm afraid; from the
<code>.yardopts</code> file the index should be
<code>Library/Homebrew/API.md</code>?</p></div>Mike McQuaidtag:rubydoc.tenderapp.com,2010-12-26:Comment/349942982014-10-19T14:48:50Z2014-10-19T14:48:50ZHomebrew docs don't match local output<div><p>Okay that’s the feedback I was looking for —
I’ll take another look shortly!</p>
<p>..nap</p>
<p>From: Mike McQuaid <a href=
"mailto:tender+d3d52849ea9ce2d606335d3e201c6af8d5c982194@tenderapp.com">
tender+d3d52849ea9ce2d606335d3e201c6af8d5c982194@tenderapp.com</a><br>
Reply: Mike McQuaid <a href=
"mailto:tender+d3d52849ea9ce2d606335d3e201c6af8d5c982194@tenderapp.com">
tender+d3d52849ea9ce2d606335d3e201c6af8d5c982194@tenderapp.com</a>></p></div>naptag:rubydoc.tenderapp.com,2010-12-26:Comment/349942982014-10-19T16:03:26Z2014-10-19T16:03:26ZHomebrew docs don't match local output<div><p>Rubydoc is warning that it can't find the referenced readme
(used with the --main switch):</p>
<pre>
<code>[warn]: Could not find readme file: Library/Homebrew/API.md</code>
</pre>
<p>Try this?</p>
<pre>
<code>https://github.com/zapnap/homebrew/blob/master/.yardopts</code>
</pre>
<p>Let me know if that's not what you're looking for.</p></div>naptag:rubydoc.tenderapp.com,2010-12-26:Comment/349942982014-10-19T17:35:21Z2014-10-19T17:35:21ZHomebrew docs don't match local output<div><p>Reopening...</p></div>naptag:rubydoc.tenderapp.com,2010-12-26:Comment/349942982014-10-19T17:44:57Z2014-10-19T17:44:58ZHomebrew docs don't match local output<div><p>Thanks! The doc timestamp looks like it has updated again but
things are still the same.</p>
<p>I've tried to add more stuff to the .yardoc file so it'll be
found. Is there any way to reproduce my setup locally that you run
there; I'm confused that I didn't see the same error locally.</p>
<p>Also, not sure if the web hook is working for this repo?</p></div>Mike McQuaidtag:rubydoc.tenderapp.com,2010-12-26:Comment/349942982014-10-19T18:20:28Z2014-10-19T18:20:41ZHomebrew docs don't match local output<div><p>Looks like the issue is that the
<code>Library/Homebrew/API.md</code> is cleaned up so it can't be
found at request time.</p></div>Mike McQuaidtag:rubydoc.tenderapp.com,2010-12-26:Comment/349942982014-10-19T20:15:33Z2014-10-19T20:17:04ZHomebrew docs don't match local output<div><p>Jumping in here--</p>
<p>We clean up the repos we checkout to remove all the "source
code" after YARD has processed it so we can save on disk space. We
end up saving ~80% of the project's size this way, which can be in
the order of mb for some projects. This adds up over the tens of
thousands of projects we have checked out.</p>
<p>All that to say-- in order for YARD to detect "extra files"
(what we call those readme things), those files need to be
specified in the .yardopts. Incidentally that's also how YARD
detects extra files.</p>
<p>The actual YARD format for specifying extra files is <code>yard
[opts] SRC_FILES - EXTRA_FILES</code>, noting the "-" separator.
Therefore, the <code>.yardopts</code> you actually want to be using
is:</p>
<pre>
<code>--title "Homebrew"
--main Library/Homebrew/API.md
--exclude Library/Homebrew/test/vendor/
--exclude Library/Homebrew/vendor/
Library/Homebrew/**/*.rb
-
Library/Homebrew/*.md
*.md</code>
</pre>
<p>I think the lack of a "-" is what is causing YARD to treat your
extra files as source code and then attempt to clean them up.</p>
<p>This is what it looks like with the "-": <a href=
"http://www.rubydoc.info/github/lsegal/homebrew/master/frames">http://www.rubydoc.info/github/lsegal/homebrew/master/frames</a>
-- you'll also start seeing those files show up in your Files list
now too.</p>
<p>Just submitted a PR for that on your project. Hope that
helps!</p></div>lsegaltag:rubydoc.tenderapp.com,2010-12-26:Comment/349942982014-10-21T21:40:50Z2014-10-21T21:40:51ZHomebrew docs don't match local output<div><p>All sorted now, thanks!</p></div>Mike McQuaid