rbur004
commented
7 years ago Put your doc site link in the description above.
Above where?
Get rid of your bad links there while you're at it.
Which bad links?
I use https://code.visualstudio.com/ with the Rubocop extension and see a lot of green squiggly underlines in your code.
What do green squiggly lines signify in visual studio? I've never used Windows.
I like your doc link with no frames. Maybe you could respond with how that got done.
The documentation is generated from the comments in the code, using Yard. Needed to install yard gem, and the hoe-yard gem (as I use the hoe gem to generate the gems).
Original setup has project/doc and project/project.
Project/doc has a checked out copy of the documentation tree.
Project/project is the code in the repo.
It's a bit messy to maintain, as it doesn't map well to the github repo, and I need to refactor it sometime.
i.e. initial setup was done with this script (Warning: Unix/Linux land stuff follows)
#!/bin/sh
mkdir sunriseset
cd sunriseset
#Create initial directory layout with hoe gem's sow tool
sow sunriseset
#move to sunriseset/sunriseset
cd sunriseset
git init
git remote add origin git@github.com:rbur004/sunriseset.git
cd ..
mkdir doc
cd doc
git init
git remote add origin git@github.com:rbur004/sunriseset.git
git fetch origin
#next line fails in this script, but works when run manually. Don't know why.?
git checkout --orphan gh-pagesThen each update of the doc is done by gendoc.sh.
Put your doc site link in the description above. Get rid of your bad links there while you're at it. I use https://code.visualstudio.com/ with the Rubocop extension and see a lot of green squiggly underlines in your code. If you like I'll make a pull request and you may see what I did with that tool. I didn't refactor though as that is more work. But you can see what I see with that tool. Pretty good code otherwise. I like your doc link with no frames. Maybe you could respond with how that got done.