it-swarm.xyz

Документация по автономному API Ruby и Ruby on Rails

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

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

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

38
denisjacquemin

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

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


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

Для Windows/Linux try Zeal

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

Ручная загрузка:

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

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

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

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

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

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

https://Gist.github.com/2149669

YARD Server

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

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

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

24
alex.zherdev

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

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

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

14
Manuel Meurer

В рамках вашего проекта Rails:

API:

rake doc:Rails

Руководства:

Добавьте драгоценный камень RedCloth в свой Gemfile

gem 'RedCloth'

Затем

rake doc:guides
8
emj365

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

5
Mladen Jablanović

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

4
Lorenz

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

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

bundle exec rake rdoc

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

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

В посте Аслама также показано, как создать копию Руководства по Rails.

3
Charles Worthington

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

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

3
Priit

Если вы работаете в Windows Создайте свой собственный документ API для поиска в Ruby и Rails post - хороший способ его сгенерировать.

2
Dinesh P.R.

Как насчет http://railsapi.com/ ?

2
Matěj G.

Вы можете использовать самоцвет apidoco. Его легко и просто использовать. Есть так много гибких функций тоже.

Gem: https://rubygems.org/gems/apidoco/versions/0.1.0

Документы: https://github.com/72pulses/apidoco

1
Nidhin S G

Я нашел этот вопрос в поиске Google, когда искал автономную документацию. Он сделал свою работу, но я публикую эту ссылку, которая в настоящее время содержит (и облегчает) все документы для автономного использования для других людей, которые оказались здесь. ДОКУМЕНТЫ

0
ollaollu

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

Тем не менее, я понятия не имею, работает ли он по-прежнему или воспроизводит Nice с rvm. Я думаю, что он был заброшен ... Жаль, хотя, это был очень хороший инструмент.

0
Pedro Morte Rolo