Documentation sur les API hors ligne Ruby et Ruby on Rails

Question

Dans le passé, j'ai utilisé railsbrain.com pour avoir une documentation d'api hors ligne agréable et pratique.

Mais ils s'arrêtent à la version 2.3.2

Existe-t-il une autre solution avec la dernière version.

Answer 1

Solution basée sur un navigateur - Mis à jour le 19 octobre 2017

DevDocs ( https://devdocs.io/ ) utilise la base de données indexée de votre navigateur pour stocker la documentation que vous souhaitez. Veillez à suivre les instructions relatives à l'installation de la documentation avant de vous déconnecter.

---

Para macOS essayer Tiret

Para Windows/Linux essayer Zèle

Para HTML conditionné essayer RubyDocs

Télécharger le manuel :

J'ai utilisé cette commande sur mon serveur afin d'obtenir les fichiers plus rapidement (ils étaient mis en cache, allez savoir pourquoi).

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

• r - récursif
• k - convertir les liens pour qu'ils pointent vers des fichiers locaux
• p - obtenir tous les images, etc. nécessaires à l'affichage des pages html

Ensuite, je compresse le dossier pour pouvoir le télécharger sans surcharge.

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

• a - ajouter des fichiers
• r - récursif

https://gist.github.com/2149669

Serveur YARD

Je préfère le format yard à rdoc.

1. Installer la gem gem install yard ,
2. Régénérer toute la documentation gem rdoc --all --overwrite et
3. Exécuter le serveur pour les gemmes yard server --gems .

Answer 2

railsapi.com . Vous pouvez construire et télécharger un paquet personnalisé de documents pour les versions de ruby jusqu'à 1.9, rails jusqu'à 2.3.5 et un certain nombre de pierres précieuses.

Answer 3

Je me rends compte que cette question est assez ancienne, mais comme elle apparaît toujours en haut de Google lorsque l'on cherche "ruby on rails docs" et que plusieurs personnes suggèrent railsapi.com, qui est hors service depuis près d'un an, j'ai décidé de la poser à mon tour.

Je voulais donc mentionner http://rubydocs.org qui a les mêmes fonctionnalités que railsapi.com et plus encore (générer des docs combinés de Ruby et Rails avec n'importe quelle version dont vous avez besoin).

Clause de non-responsabilité : j'ai construit http://rubydocs.org . :)

Answer 4

Dans votre projet rails :

API :

rake doc:rails

Guides :

Ajoutez la gem RedCloth à votre Gemfile

gem 'RedCloth'

Dans ce cas

rake doc:guides

Answer 5

Editer (février 2016) : http://devdocs.io/ semble correct

Pour ne pas passer sous silence, vous pouvez également lancer un serveur gem rdoc local :

$ gem server
Starting gem server on http://localhost:8808/
localhost - - [13/Mar/2010:18:34:44 CET] "GET / HTTP/1.1" 200 22403
- -> /

Mais il manque des informations sur la bibliothèque de base de Ruby.