https://github.com/zapnap/rdocinfo
New development has moved to http://github.com/lsegal/rubydoc.info
https://github.com/zapnap/rdocinfo
Last synced: about 1 year ago
JSON representation
New development has moved to http://github.com/lsegal/rubydoc.info
- Host: GitHub
- URL: https://github.com/zapnap/rdocinfo
- Owner: zapnap
- License: mit
- Created: 2009-04-20T19:53:04.000Z (about 17 years ago)
- Default Branch: master
- Last Pushed: 2010-09-01T16:26:59.000Z (almost 16 years ago)
- Last Synced: 2025-05-03T14:42:04.560Z (about 1 year ago)
- Language: JavaScript
- Homepage: http://rdoc.info
- Size: 1.47 MB
- Stars: 18
- Watchers: 1
- Forks: 3
- Open Issues: 14
-
Metadata Files:
- Readme: README.rdoc
- License: MIT-LICENSE
Awesome Lists containing this project
README
= RdocInfo
A simple Sinatra-based web service that generates and hosts rdocs (actually,
yardocs) for GitHub-based projects. Accepts updates from post-commit hooks and
regenerates as needed. Public service is hosted at http://rdoc.info or
http://rubydoc.info
PLEASE NOTE: future development of this service has moved to the new
rubydoc.info project. See http://github.com/lsegal/rubydoc.info for more
information!! Thanks and namaste.
== 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:
* Install the YARD gem -- see http://github.com/lsegal/yard
* Create a symlink from /public/rdoc to ../rdoc/default
Note that we currently use a customized version of YARD in production that
filters potentially unsafe yardoc options such as --query.
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 if you're interested in this
stuff.
== Getting Started
rake gems:install
rake db:migrate
ruby bin/run.rb
== Credit
Rdoc.info is (c) 2010 Nick Plante. This code is distributed under the MIT license.
The following individuals have contributed to the project:
* Loren Segal (for YARD)
* Jeff Rafter
* Brian Turnbull