tag:rubydoc.tenderapp.com,2010-12-26:/discussions/questions/242-github-specific-branchRubydoc.info: Discussion 2015-05-19T19:57:38Ztag:rubydoc.tenderapp.com,2010-12-26:Comment/368565332015-05-17T22:01:31Z2015-05-17T22:01:31ZGithub specific branch<div><p>Can you explain what is ugly and annoying about having
documentation in your code? If it helps, you should not be checking
in any generated files (HTML or the .yardoc dir) into your
repository,</p></div>lsegaltag:rubydoc.tenderapp.com,2010-12-26:Comment/368565332015-05-17T22:06:11Z2015-05-17T22:06:12ZGithub specific branch<div><p>Ah...I should explain. All my code is documented with gigantic
comments explaining what everthing does. That's not the issue
:)</p>
<p>When I generate documentation with yard it creates a "doc"
folder that contains lots of js, html and css files.</p>
<p>I was under the impression that I had to commit all those HTML,
JS and CSS files into git to use rubydoc? That's what I made a
branch for called "yard-docs" so that all those nasty files don't
cluster up my master branch (and ruin my wonderfully red 100% ruby
language statistic ^^)</p>
<p>This is the first time I'm having to use a tool like that to
host documentation (I only write wikis usually) so excuse me if I'm
not understanding this right. Do I not need the generated files
from yard in my repo? How does rubydoc then generate the
documentation?</p></div>Katetag:rubydoc.tenderapp.com,2010-12-26:Comment/368565332015-05-17T22:24:55Z2015-05-17T22:24:55ZGithub specific branch<div><blockquote>
<p>I was under the impression that I had to commit all those HTML,
JS and CSS files into git to use rubydoc?</p>
</blockquote>
<p>Nope. Rubydoc does not use those files. We generate a fresh copy
on our side every time the repository is updated right from the
source code. Effectively we're running <code>yard doc</code> on our
side when we serve your docs so you don't have to.</p>
<p>Hope that helps!</p></div>lsegaltag:rubydoc.tenderapp.com,2010-12-26:Comment/368565332015-05-17T22:33:43Z2015-05-17T22:33:50ZGithub specific branch<div><p>Oooh...I see. Okay that makes more sense :P In that case, I'll
ditch that branch and just merge all my docs that I wrote on
develop into master. Thanks :)</p></div>Katetag:rubydoc.tenderapp.com,2010-12-26:Comment/368565332015-05-19T19:57:38Z2015-05-19T19:57:38ZGithub specific branch<div><p>No problem Kate. Glad you got a path forward. If you have other
issues or questions with the site or YARD, feel free to ask!</p></div>lsegal