В прошлом я использовал railsbrain.com, чтобы иметь приятную и удобную автономную документацию api.
Но они останавливаются на версии 2.3.2
Есть ли другое решение с последней версией.
В прошлом я использовал railsbrain.com, чтобы иметь приятную и удобную автономную документацию api.
Но они останавливаются на версии 2.3.2
Есть ли другое решение с последней версией.
Браузерное решение - Обновлено 19 октября 2017 г.
DevDocs (https://devdocs.io/) использует ваш браузер IndexedDB для хранения необходимой документации. Перед тем, как перейти в автономный режим, следуйте инструкциям по установке документов.
Для macOS попробуйте Dash
Для Windows/Linux попробуйте Zeal
Для упакованного HTML попробуйте RubyDocs
Загрузка вручную:
Я использовал эти команды на своем сервере, чтобы быстрее получить файлы (они были кешированы, иди рисунок).
wget -r -k -p http://api.rubyonrails.org/
Затем я сжимаю папку, поэтому я могу загрузить ее без накладных расходов.
rar a -r rails_api.rar api.rubyonrails.org/
https://gist.github.com/2149669
Сервер YARD
Я предпочитаю формат ярдов над rdoc.
gem install yard
,gem rdoc --all --overwrite
иyard server --gems
.railsapi.com. Вы можете создавать и загружать собственный пакет документов для рубиновых версий до 1.9, rails до 2.3.5 и нескольких драгоценных камней.
Я понимаю, что этот вопрос довольно старый, но поскольку он все еще поднимается высоко в Google при поиске "ruby on rails docs", и несколько человек предлагают railsapi.com, который был почти год назад.
Итак, я хотел упомянуть http://rubydocs.org, который имеет те же функции, что и railsapi.com, и многое другое (создавайте комбинированные документы Ruby и Rails с любой версией необходимо).
Отказ от ответственности: я построил http://rubydocs.org.:)
В рамках проекта rails:
API:
rake doc:rails
Guides:
Добавить жемчужину RedCloth в ваш Gemfile
gem 'RedCloth'
Тогда
rake doc:guides
Изменить (февраль 2016): http://devdocs.io/ выглядит нормально
Просто, чтобы не пройти без изменений, вы также можете запустить локальный сервер gem rdoc:
$ gem server
Starting gem server on http://localhost:8808/
localhost - - [13/Mar/2010:18:34:44 CET] "GET / HTTP/1.1" 200 22403
- -> /
Но ему не хватает информации о базовой библиотеке Ruby.
Я рекомендую bdoc
. Это замена для gem server
, которая не требует наличия сервера и выглядит намного приятнее. Просто сделайте gem install bdoc; bdoc
или посмотрите здесь более подробную информацию. Здесь вы можете найти bdoc .
Если вы на Mac, я собрал словарь с документацией Rails 3.0 http://prii.it/blog/rails-3-dictionary-update. У меня не было времени сделать это для Rails 3, но сделаю это, когда я нахожусь в настроении.
Другие версии Rails также доступны.
Как насчет http://railsapi.com/?
Я нашел Aslam post в этом разделе, чтобы быть наиболее полезным, простым в реализации ответа на этот вопрос, и он работает для текущей версии Rails API и Rails Guides. Благодаря Асламу, чтобы собрать его вместе.
В принципе, вы клонируете текущую репозитарию Rails git на свой компьютер, а затем запустите
bundle exec rake rdoc
из каталога rails.
Оттуда вы можете скопировать папку документации в другое место на вашем компьютере и запустить локально из браузера.
Aslam post также показывает вам, как создать копию Rails Guides.
Если вы находитесь в Windows Создайте свой собственный Ruby и Rails Searchable API Doc, это хороший способ его создания.
Вы можете использовать драгоценный камень apidoco
. Его легко и просто использовать. Также есть много гибких функций.
Gem: https://rubygems.org/gems/apidoco/versions/0.1.0
Документы: https://github.com/72pulses/apidoco
Несколько лет назад я использовал FXRI, что было довольно круто: http://rubyforge.org/projects/fxri/
Хотя, я понятия не имею, работает ли он или работает ли он с rvm. Думаю, это было заброшено. Очень жаль, но это был очень хороший инструмент.
Я нашел этот вопрос в поиске Google, ища автономную документацию. Он выполнил эту работу, но я размещаю эту ссылку, которая в настоящее время содержит (и упрощает) все документы для автономного использования для других людей, которые оказались здесь. DOCS