yard server
gem inabox gem_name --host rubygems.home.local
gem install gem_name
systemctl restart docsserver.service
yard upload gem_name
Hello,
You can look at the way this works for rubydoc.info, which is an open sourced project to manage serving docs for arbitrary gems: https://github.com/docmeta/rubydoc.info
The TLDR of it is that gems are pulled by the service (the service being an extended YARD server) itself rather than uploaded to rubydoc.info. I suppose you can build some kind of .gem upload queue, but if your gem is published and publicly accessible, you can just link to that gem, download, unpack, and process the source as is done with this YARD server extension code:
https://github.com/docmeta/rubydoc.info/blob/master/lib/extensions.rb#L30
The `load_yardoc_from_XXXX` methods provided by the above
extension allow YARD to load documentation from extra sources, one
of which being "remote_gem", which can download and unpack for
processing. The implementation for expanding the gem is in that
file as well. This extension API is documented in https://rubydoc.info/gems/yard/YARD/Server/LibraryVersion
and can be used to avoid pushing data to your server (instead have
the server pull).
Hope that helps!
Loren
--
---
You received this message because you are subscribed to the Google Groups "YARD" group.
To unsubscribe from this group and stop receiving emails from it, send an email to yardoc+un...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/yardoc/a44e4c5e-d50d-4e5e-b08c-4c42fbafea27%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.