yard

Documentation tool for Ruby. More information: <https://yardoc.org/>.

Install

All systems
curl cmd.cat/yard.sh
Debian Debian
apt-get install yard
Ubuntu
apt-get install yard
Arch Arch Linux
pacman -S yard
image/svg+xml Kali Linux
apt-get install yard
Fedora
dnf install yard
Windows (WSL2)
sudo apt-get update sudo apt-get install yard
Raspbian
apt-get install yard

Documentation tool for Ruby. More information: <https://yardoc.org/>.

  • Create the documentation:
    yard
  • Create the documentation and save it to one file:
    yard --one-file
  • List all undocumented objects:
    yard stats --list-undoc

© tl;dr; authors and contributors