Hooking into RDoc for better documentation with automatically executed examples

This page summarizes the projects mentioned and recommended in the original post on reddit.com/r/ruby

Our great sponsors
  • InfluxDB - Build time-series-based applications quickly and at scale.
  • SonarQube - Static code analysis for 29 languages.
  • SaaSHub - Software Alternatives and Reviews
  • hexapdf-website

    The source of the HexaPDF documentation website

    Since the API documentation was already part of the static website generation, I added an additional hook that scans for specially marked-up verbatim blocks and executes those blocks - see https://github.com/gettalong/hexapdf-website/blob/master/ext/rdoc_pdf_images.rb

  • HexaPDF

    Versatile PDF creation and manipulation for Ruby

    After I got some feedback about missing examples in the API documentation of HexaPDF, I decided to do something about it.

  • InfluxDB

    Build time-series-based applications quickly and at scale.. InfluxDB is the Time Series Platform where developers build real-time applications for analytics, IoT and cloud-native services. Easy to start, it is available in the cloud or on-premises.

NOTE: The number of mentions on this list indicates mentions on common posts plus user suggested alternatives. Hence, a higher number means a more popular project.

Suggest a related project

Related posts