greensync/documented

Automatic documentation

Documented

Documented writes documentation for you, from your tests. Never have out of date documentation again!

Designed to work with https://marketplace.visualstudio.com/items?itemName=bierner.markdown-mermaid for now.

Usage

Add # documented:enable and # documented:disable comments anywhere in your tests:

# documented:enable
my_method(do_stuff: true)
# documented:disable

Then run your test via the documented CLI like:

documented spec/example_spec.rb

Documentation will start showing up in the documented folder:

Installation

In Gemfile add:

gem "documented"

In terminal run:

bundle install

Or:

gem install documented

Configuration

Documented.configure do |config|
  config.blocklist = {
    'ExampleClass',
  }
end

See Config.rb for more configuration options.