Как установить документацию Ruby ri? - программирование
Подтвердить что ты не робот

Как установить документацию Ruby ri?

Недавно я установил Ruby 1.9.1 в Windows 7, и, по-видимому, он не поставляется со стандартной документацией ri. Поэтому, когда я делаю "ri Array", я получаю:

C:\>ri Array

Nothing known about Array

Есть ли способ установить эту документацию, чтобы работать выше?

4b9b3361

Ответ 1

Кажется, у вас есть инсталлятор Ruby 1.9.1, распространяемый проектом RubyInstaller.

Вы можете использовать файлы справки Windows (CHM), которые поставляются вместе с установщиком вместо документации ri.

Проблема документации RI заключается в том, что некоторые версии RDoc имеют проблемы с ее созданием, а также генерируют более 10 тысяч файлов, что значительно замедляет работу установщиков.

Ответ 2

В случае, если люди на других платформах должны установить свои документы (как и я). В этой статье объясняется, почему и как:

http://jstorimer.com/ri.html

Команда:

gem rdoc --all --ri --no-rdoc

Ответ 3

Если вы используете rvm, вы должны rvm docs generate (или просто rvm docs generate-ri)

Смотрите эту информацию (2011August) о rvm и ri

Ответ 4

Ни один из предлагаемых решений не работал у меня. В итоге решение, которое я нашел, было очень простым, поэтому я оставлю его здесь. (Я запускаю ruby ​​2.2.4 на win7 x64 в случае, если это релевантно)

(очевидное предупреждение капитана: рубин должен быть установлен и в вашем PATH)

-open cmd

-$ gem install rdoc-data

-$ rdoc-data --install

И ты настроен! проверьте, работает ли он:

-$ ri Array Он должен предоставить вам всю прекрасную документацию для класса!

Надеюсь, это поможет!

пс. Я только заметил, что это решение, которое Луис Лавена предложил в комментарии, но его комментарий не был ясен для меня, поэтому я продолжал искать. В основном это одно и то же решение, но объясняемое более четко, чтобы этого не случилось с кем-либо еще:)

Ура!

Ответ 5

RVM автоматически не создает и не устанавливает каждую документацию Ruby ri/rdoc. Вы можете создать следующую команду: rvm docs генерирует

Ответ 6

Все документы Ruby находятся на http://www.ruby-doc.org

Итак, документация массива:

http://ruby-doc.org/core/classes/Array.html

Никогда не пробовал это на окнах, но потому, что его высказывание "Nothing Known about X" не означает, что его не установлено, ничего не получилось.

Попробуйте установить драгоценный камень, как вы можете, затем ri GEM_CLASS, так как это должно обеспечить отказ, должно позволить нам увидеть, отсутствует ли его недостающая документация или если ri не выглядит в нужном месте

Ответ 7

В Ruby Installer 2.4.1.2 (2017 год) все еще остается в значительной степени. Если я запустил ri Array, он показывает Array < Object и ничего больше. Если я запустил ri "Array#each", я получу знакомое сообщение "Nothing known...". Короче говоря, документация ri-формата для ядра Ruby и стандартных библиотек отсутствует.

Вот как я получил свою копию core/stdlib ri-документации. Конечно, Ruby должен быть установлен до этого.

  • Получить исходный код ruby, который наиболее точно соответствует моей версии из их Github выпускает страницу.
  • Извлеките архив .zip или .tar.gz в какую-то папку
  • Откройте cmd.exe/Powershell, cd в эту папку и запустите rdoc --all --ri
    • Эта команда рекурсивно анализирует файлы .c,.rb и несколько других типов файлов в текущем каталоге и генерирует ri-документацию в каталог ~/.rdoc.
    • Взял около 5 минут на моем ноутбуке с процессором i7-3520M для завершения, без ошибок.
  • Удалите архив и каталог, содержащий исходный код, потому что они нам больше не нужны.

Теперь, если вы попытаетесь запустить ri Array или ri "Array#each", вы получите документацию во всей красе.

TL;DR

Запустите rdoc --all --ri в каталоге, содержащем исходный код для той же версии ruby, что и ваша установленная версия.


Приложение Z: Комментарии к другим ответам

  • rvm docs generate-ri может работать, но вы должны использовать Cygwin или Ubuntu в Windows (если в Windows 10) использовать rvm.
  • gem rdoc --all --ri --no-rdoc устанавливает ri-документацию для всех ваших драгоценных камней. Он не устанавливает документацию core/stdlib.
  • gem install rdoc-data, за которым следует rdoc-data --install, работает только для версий Ruby до 2.3.0.