diff --git a/docs/asciidoc_index.rb b/docs/asciidoc_index.rb index 3be02b58c..be1b94403 100644 --- a/docs/asciidoc_index.rb +++ b/docs/asciidoc_index.rb @@ -4,7 +4,7 @@ require "erb" if ARGV.size != 2 $stderr.puts "No path given to search for plugin docs" - $stderr.puts "Usage: #{$0} plugin_doc_dir" + $stderr.puts "Usage: #{$0} plugin_doc_dir type" exit 1 end @@ -26,4 +26,10 @@ docs = plugins(File.join(basedir, "#{type}/*.asciidoc")) template_path = File.join(File.dirname(__FILE__), "index-#{type}.asciidoc.erb") template = File.new(template_path).read erb = ERB.new(template, nil, "-") -puts erb.result(binding) + +path = "#{basedir}/#{type}.asciidoc" + +File.open(path, "w") do |out| + html = erb.result(binding) + out.puts(html) +end diff --git a/docs/plugin-doc.asciidoc.erb b/docs/plugin-doc.asciidoc.erb index 8309011ae..3860efbf5 100644 --- a/docs/plugin-doc.asciidoc.erb +++ b/docs/plugin-doc.asciidoc.erb @@ -23,8 +23,11 @@ These are the config options end -%> [[plugins-<%= section%>s-<%= plugin_name%>-<%= name%>]] -===== `<%= name %>` <%= " (required setting)" if config[:required] %><%= " (DEPRECATED)" if config[:deprecated] %> +===== `<%= name %>` <%= " (DEPRECATED)" if config[:deprecated] %> +<% if config[:required] -%> + * This is a required setting. +<% end -%> <% if config[:deprecated] -%> * DEPRECATED WARNING: This config item is deprecated. It may be removed in a further version. <% end -%>