Как мне установить документацию по Ruby ri? - PullRequest
22 голосов
/ 05 июля 2010

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

C:\>ri Array

Nothing known about Array

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

Ответы [ 7 ]

33 голосов
/ 15 декабря 2012

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

http://jstorimer.com/ri.html

Команда:

gem rdoc --all --ri --no-rdoc
21 голосов
/ 21 февраля 2013

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

См. эту информацию (2011 августа) о rvm и ri

7 голосов
/ 23 февраля 2016

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

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

-открытый cmd

-$ gem install rdoc-data

-$ rdoc-data --install

И все готово!проверьте, что это работает, запустив:

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

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

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

Ура!

6 голосов
/ 05 июля 2010

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

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

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

4 голосов
/ 01 апреля 2016

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

3 голосов
/ 17 августа 2017

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

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

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

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

Т.Л., др

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


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

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

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

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

http://ruby -doc.org / ядро ​​/ классы / Array.html

Никогда не пробовал это на Windows, но потому, что в нем говорится «Ничего не известно о Х», не то, что он не установлен, просто не получил ничего.

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

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...