Documentation de l'API hors ligne Ruby et Ruby on Rails
Dans le passé, j’utilisais railsbrain.com pour obtenir une documentation 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?.
Solution basée sur un navigateur - Mis à jour le 19 oct. 2017
DevDocs ( https://devdocs.io/ ) utilise IndexedDB de votre navigateur pour stocker la documentation de votre choix. Assurez-vous de suivre les instructions d'installation des documents avant de vous déconnecter.
Pour macOS try Dash
Pour Windows/Linux try Zeal
Pour HTML emballé try RubyDocs
Téléchargement manuel :
J'ai utilisé ces commandes sur mon serveur pour pouvoir obtenir les fichiers plus rapidement (ils étaient mis en cache, allez comprendre).
wget -r -k -p http://api.rubyonrails.org/
- r - récursif
- k - convertit les liens pour qu'ils pointent vers des fichiers locaux
- p - obtenir toutes les images , etc. nécessaires pour afficher les pages html
Ensuite, je compresse le dossier afin de 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
YARD Server
Je préfère le format yard par rapport à rdoc.
- Installez le gem
gem install yard, - Régénérez toute la documentation
gem rdoc --all --overwrite, et - Exécutez le serveur pour le gems
yard server --gems.
railsapi.com . Vous pouvez créer et télécharger un package personnalisé de documents pour les versions de Ruby vers la version 1.9, Rails vers la version 2.3.5 et un certain nombre de gems.
Je me rends compte que cette question est assez ancienne, mais comme elle est toujours d'actualité dans Google lors de la recherche de "documents Ruby on Rails", plusieurs personnes suggèrent que railsapi.com est en panne depuis près d'un an.
Je voulais donc mentionner http://rubydocs.org , qui possède les mêmes fonctionnalités que railsapi.com et plus encore (générer des docs combinés de Ruby et Rails avec la version de votre choix).
Disclaimer: J'ai construit http://rubydocs.org . :)
Dans votre projet Rails:
API:
rake doc:Rails
Guides:
Ajoutez la gemme RedCloth à votre Gemfile
gem 'RedCloth'
Ensuite
rake doc:guides
Edit (février 2016): http://devdocs.io/ semble ok
Juste pour ne pas passer sous silence, vous pouvez également démarrer le serveur local 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
- -> /
Mais il manque des informations sur la bibliothèque de base Ruby.
Je recommande bdoc. C’est un remplacement de gem server qui ne nécessite pas de serveur en marche et qui est beaucoup plus joli. Il suffit de faire gem install bdoc; bdoc ou de vérifier plus de détails ici. Vous pouvez trouver bdoc ici .
J'ai trouvé le message d'Aslam sur ce sujet était le plus utile, facile à implémenter pour répondre à cette question, et cela fonctionne pour la version actuelle de l'API Rails et de ses guides. Merci à Aslam pour l'avoir mis en place.
Fondamentalement, vous clonez le dépôt git Rails actuel sur votre ordinateur, puis exécutez
bundle exec rake rdoc
depuis le répertoire Rails.
À partir de là, vous pouvez copier le dossier de documentation ailleurs sur votre ordinateur et l'exécuter localement à partir d'un navigateur.
L'article d'Aslam vous explique également comment générer une copie des guides Rails.
Si vous utilisez un Mac, j'ai créé un dictionnaire avec la documentation de Rails 3.0 http://prii.it/blog/Rails-3-dictionary-update . Je n'ai pas eu le temps de le faire pour Rails 3, mais le ferai une fois que je suis d'humeur d'humeur.
D'autres versions de Rails sont également disponibles.
Si vous êtes sur Windows Construisez votre propre Docu API Ruby and Rails Searchable post est un bon moyen de le générer.
Qu'en est-il http://railsapi.com/ ?
Vous pouvez utiliser apidoco gem. C'est facile et simple à utiliser. Vous avez aussi beaucoup de fonctionnalités flexibles.
J'ai trouvé cette question dans une recherche Google en cherchant de la documentation hors ligne. Il a fait le travail, mais je poste ce lien qui contient (et le rend plus facile) tous les documents pour une utilisation hors connexion pour les autres personnes qui se trouvent ici. DOCS
Il y a quelques années, j’utilisais FXRI, ce qui était plutôt cool: http://rubyforge.org/projects/fxri/
Bien que, je n'ai aucune idée si cela fonctionne toujours ou s'il joue bien avec RVM. Je suppose que cela a été abandonné. Dommage, c’était un très bel outil.