Документация по API-интерфейсу Ruby и Ruby on Rails

В прошлом я использовал railsbrain.com, чтобы иметь приятную и удобную автономную документацию api.

Но они останавливаются на версии 2.3.2

Есть ли другое решение с последней версией.

Ответы

Ответ 1

Браузерное решение - Обновлено 19 октября 2017 г.

DevDocs (https://devdocs.io/) использует ваш браузер IndexedDB для хранения необходимой документации. Перед тем, как перейти в автономный режим, следуйте инструкциям по установке документов.

Для macOS попробуйте Dash

Для Windows/Linux попробуйте Zeal

Для упакованного HTML попробуйте RubyDocs

Загрузка вручную:

Я использовал эти команды на своем сервере, чтобы быстрее получить файлы (они были кешированы, иди рисунок).

wget -r -k -p http://api.rubyonrails.org/

  • r - рекурсивный
  • k - конвертировать ссылки в локальные файлы
  • p - получить все изображения и т.д., необходимые для отображения html-страниц

Затем я сжимаю папку, поэтому я могу загрузить ее без накладных расходов.

rar a -r rails_api.rar api.rubyonrails.org/

  • a - добавить файлы
  • r - рекурсивный

https://gist.github.com/2149669

Сервер YARD

Я предпочитаю формат ярдов над rdoc.

  • Установите драгоценный камень gem install yard,
  • Восстановите всю документацию gem rdoc --all --overwrite и
  • Запустите сервер для драгоценных камней yard server --gems.

Ответ 2

railsapi.com. Вы можете создавать и загружать собственный пакет документов для рубиновых версий до 1.9, rails до 2.3.5 и нескольких драгоценных камней.

Ответ 3

Я понимаю, что этот вопрос довольно старый, но поскольку он все еще поднимается высоко в Google при поиске "ruby on rails docs", и несколько человек предлагают railsapi.com, который был почти год назад.

Итак, я хотел упомянуть http://rubydocs.org, который имеет те же функции, что и railsapi.com, и многое другое (создавайте комбинированные документы Ruby и Rails с любой версией необходимо).

Отказ от ответственности: я построил http://rubydocs.org.:)

Ответ 4

В рамках проекта rails:

API:

rake doc:rails

Guides:

Добавить жемчужину RedCloth в ваш Gemfile

gem 'RedCloth'

Тогда

rake doc:guides

Ответ 5

Изменить (февраль 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.

Ответ 6

Я рекомендую bdoc. Это замена для gem server, которая не требует наличия сервера и выглядит намного приятнее. Просто сделайте gem install bdoc; bdoc или посмотрите здесь более подробную информацию. Здесь вы можете найти bdoc .

Ответ 7

Если вы на Mac, я собрал словарь с документацией Rails 3.0 http://prii.it/blog/rails-3-dictionary-update. У меня не было времени сделать это для Rails 3, но сделаю это, когда я нахожусь в настроении.

Другие версии Rails также доступны.

Ответ 9

Я нашел Aslam post в этом разделе, чтобы быть наиболее полезным, простым в реализации ответа на этот вопрос, и он работает для текущей версии Rails API и Rails Guides. Благодаря Асламу, чтобы собрать его вместе.

В принципе, вы клонируете текущую репозитарию Rails git на свой компьютер, а затем запустите

bundle exec rake rdoc

из каталога rails.

Оттуда вы можете скопировать папку документации в другое место на вашем компьютере и запустить локально из браузера.

Aslam post также показывает вам, как создать копию Rails Guides.

Ответ 12

Несколько лет назад я использовал FXRI, что было довольно круто: http://rubyforge.org/projects/fxri/

Хотя, я понятия не имею, работает ли он или работает ли он с rvm. Думаю, это было заброшено. Очень жаль, но это был очень хороший инструмент.

Ответ 13

Я нашел этот вопрос в поиске Google, ища автономную документацию. Он выполнил эту работу, но я размещаю эту ссылку, которая в настоящее время содержит (и упрощает) все документы для автономного использования для других людей, которые оказались здесь. DOCS