joshnesbitt / rdocinfo
watch download tarball
public
Forks3Right
Watchers1Right
Fork of zapnap/rdocinfo
Description: Ruby Library Documentation Service
Homepage: http://rdoc.info
Clone URL: git://github.com/joshnesbitt/rdocinfo.git
name age
history
message
file .gitignore Sat Jun 06 11:40:22 -0700 2009 Added *.swp to .gitignore [bturnbull]
file Capfile Wed May 06 15:11:28 -0700 2009 Load the database from the yaml, and make sure ... [jeffrafter]
file MIT-LICENSE Sun Apr 12 11:02:50 -0700 2009 import sinatra-template [zapnap]
file README.rdoc Sun Sep 06 13:18:27 -0700 2009 give credit where credit is due [zapnap]
file Rakefile Mon Sep 14 05:42:29 -0700 2009 add hoptoad for error logging [zapnap]
directory bin/ Wed Jun 10 13:26:39 -0700 2009 move to modular Sinatra app structure note: req... [zapnap]
file config.ru Wed Jun 10 19:37:14 -0700 2009 fix config loader [zapnap]
directory config/ Loading commit data...
directory lib/
directory log/ Wed May 06 10:34:06 -0700 2009 Clean up the defaults and move the config ymls ... [jeffrafter]
directory public/
directory spec/
directory templates/ Mon May 18 11:00:42 -0700 2009 Fix the typo on the redirect [jeffrafter]
directory views/
README.rdoc

RdocInfo

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

Configuration

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:

Once you’ve done that you should be ready to rock.

GitHub Pages Integration

GitHub Pages support has been removed from master as it was proving to be a bit unreliable. Check the github-pages branch.

Getting Started

  rake db:migrate
  ruby application.rb

Credit

Rdoc.info is © 2009 Nick Plante. This code is distributed under the MIT license.

The following individuals have contributed to the project:

  • Jeff Rafter
  • Brian Turnbull

Contribute

Contributions are welcome and appreciated. See GitHub project issues for a list of specific features that have been requested or discussed.