Github specific branch
I want to have all my documentation on a branch called
"yard-docs" so that it doesn't reside in the master or develop
branch which I find ugly and annoying.
Is that possible? If so, how?
Couldn't find the answer while googling :(
Comments are currently closed for this discussion. You can start a new one.
Keyboard shortcuts
Generic
| ? | 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
Support Staff 1 Posted by lsegal on 17 May, 2015 10:01 PM
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,
2 Posted by Kate on 17 May, 2015 10:06 PM
Ah...I should explain. All my code is documented with gigantic comments explaining what everthing does. That's not the issue :)
When I generate documentation with yard it creates a "doc" folder that contains lots of js, html and css files.
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 ^^)
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?
Support Staff 3 Posted by lsegal on 17 May, 2015 10:24 PM
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
yard docon our side when we serve your docs so you don't have to.Hope that helps!
4 Posted by Kate on 17 May, 2015 10:33 PM
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 :)
Support Staff 5 Posted by lsegal on 19 May, 2015 07:57 PM
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!
lsegal closed this discussion on 19 May, 2015 07:57 PM.