A simple Sinatra-based web service that generates and hosts rdocs for GitHub-based projects. Accepts updates from post-commit hooks and regenerates as needed. Public service is hosted at rdoc.info
All configuration is done in the conf directory via environment yaml files. Copy development.yml.example to development.yml within that directory and alter the settings to match your local environment.
There are a couple additional steps you’ll need to take to get rdoc.info working:
-
Install the YARD gem – see github.com/lsegal/yard
-
Create a symlink from /public/rdoc to ../rdoc/default
Once you’ve done that you should be ready to rock.
Rdoc.info can now push GitHub-themed doc files directly to a GitHub account. Toggle the enable_push and github_doc_pages options in the yaml config to set this up and make sure the appropriate keys are in place. This support is still considered experimental :).
rake db:migrate ruby application.rb
All contributions are welcome. See GitHub project issues for a list of specific features that have been requested or discussed.