Project

doc-server

0.0
No release in over a year
doc-serverdanielheath/doc-serverHomepageDocumentationSource CodeBug TrackerWiki
Serves documentation for installed gems locally on HTTP, with full text search
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
410
Stars
0
Forks
0
Watchers
2
 Releases
Current version
0.0.1
Total releases
1
First release
2023-03-03
Latest release
2023-03-03
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2023-03-03
Reverse Dependencies
0

 Dependencies

Runtime

parser
>= 0
rack
>= 0
webrick
>= 0
 Project Readme

doc-server

doc-server provides gem rdoc, filtered to only the gems installed by your gemfile.

It's inspired by https://github.com/rubygems/rubygems-server and the now-defunct godoc -http.

Installation & usage

echo "gem 'doc-server'" >> Gemfile
bundle
bundle exec doc-server

This will create a directory (default='rdoc') to store the per-bundle documentation.

Whenever you install or update gems, delete this directory, and restart doc-server.

Configuration

DOCSERVER_OUTPUT_PATH: Where to store the per-bundle documentation. Default is "rdoc".

DOCSERVER_PORT: Which port to listen on. Default is 8088.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/danielheath/doc-server.

License

The gem is available as open source under the terms of the MIT License.