From c1f2404de71e9a8f73271b05f59a225728212069 Mon Sep 17 00:00:00 2001 From: Seba Gamboa Date: Thu, 24 Sep 2015 18:25:12 -0300 Subject: Generating C API HTML Layout --- templates/default/fulldoc/html/css/mruby.css | 0 .../default/fulldoc/html/full_list_headers.erb | 1 + templates/default/fulldoc/html/js/mruby.js | 0 templates/default/fulldoc/html/setup.rb | 57 ++++++++++++++++++++++ templates/default/header/html/functions.erb | 1 + templates/default/header/html/header.erb | 1 + templates/default/header/html/setup.rb | 10 ++++ .../default/includedirectory/html/headers_list.erb | 1 + templates/default/includedirectory/html/setup.rb | 10 ++++ templates/default/layout/html/setup.rb | 41 ++++++++++++++++ 10 files changed, 122 insertions(+) create mode 100644 templates/default/fulldoc/html/css/mruby.css create mode 100644 templates/default/fulldoc/html/full_list_headers.erb create mode 100644 templates/default/fulldoc/html/js/mruby.js create mode 100644 templates/default/fulldoc/html/setup.rb create mode 100644 templates/default/header/html/functions.erb create mode 100644 templates/default/header/html/header.erb create mode 100644 templates/default/header/html/setup.rb create mode 100644 templates/default/includedirectory/html/headers_list.erb create mode 100644 templates/default/includedirectory/html/setup.rb create mode 100644 templates/default/layout/html/setup.rb (limited to 'templates/default') diff --git a/templates/default/fulldoc/html/css/mruby.css b/templates/default/fulldoc/html/css/mruby.css new file mode 100644 index 0000000..e69de29 diff --git a/templates/default/fulldoc/html/full_list_headers.erb b/templates/default/fulldoc/html/full_list_headers.erb new file mode 100644 index 0000000..4b32c70 --- /dev/null +++ b/templates/default/fulldoc/html/full_list_headers.erb @@ -0,0 +1 @@ +TODO: Display C API diff --git a/templates/default/fulldoc/html/js/mruby.js b/templates/default/fulldoc/html/js/mruby.js new file mode 100644 index 0000000..e69de29 diff --git a/templates/default/fulldoc/html/setup.rb b/templates/default/fulldoc/html/setup.rb new file mode 100644 index 0000000..81ac35c --- /dev/null +++ b/templates/default/fulldoc/html/setup.rb @@ -0,0 +1,57 @@ +def init + super + + YARD::MRuby::CodeObjects::INCLUDE_DIRECTORY.tap do |root| + + # Generates the requirements splash page with the 'include' template + serialize root + + root.headers.each do |header| + serialize header + end + end + +end + +def generate_header_list + puts "generate_header_list" + headers = Registry.all(:header) + headers_ordered_by_name = headers.sort {|x,y| x.value.to_s <=> y.value.to_s } + generate_full_list headers_ordered_by_name, :headers +end + +# Helpler method to generate a full_list page of the specified objects with the +# specified type. +def generate_full_list(objects,type,options = {}) + defaults = { :list_title => "#{type.to_s.capitalize} List", + :css_class => "class", + :list_filename => "#{type.to_s.gsub(/s$/,'')}_list.html" } + + options = defaults.merge(options) + + @items = objects + @list_type = type + @list_title = options[:list_title] + @list_class = options[:css_class] + asset options[:list_filename], erb(:full_list) +end + +# +# @note This method overrides YARD's default template class_list method. +# +# The existing YARD 'Class List' search field contains all the YARD namespace objects. +# We, however, do not want the Include Namespace YARD Object (which holds the headers) +# as it is a meta-object. +# +# This method removes the namespace from the root node, generates the class list, +# and then adds it back into the root node. +# +def class_list(root = Registry.root) + return super unless root == Registry.root + + include_namespace = YARD::MRuby::CodeObjects::INCLUDE_DIRECTORY + root.instance_eval { children.delete include_namespace } + out = super(root) + root.instance_eval { children.push include_namespace } + out +end diff --git a/templates/default/header/html/functions.erb b/templates/default/header/html/functions.erb new file mode 100644 index 0000000..d5a7f72 --- /dev/null +++ b/templates/default/header/html/functions.erb @@ -0,0 +1 @@ +Header functions! diff --git a/templates/default/header/html/header.erb b/templates/default/header/html/header.erb new file mode 100644 index 0000000..dec59ee --- /dev/null +++ b/templates/default/header/html/header.erb @@ -0,0 +1 @@ +

<%= format_object_title(object) %>

diff --git a/templates/default/header/html/setup.rb b/templates/default/header/html/setup.rb new file mode 100644 index 0000000..757657d --- /dev/null +++ b/templates/default/header/html/setup.rb @@ -0,0 +1,10 @@ +def init + puts "header!" + puts object.inspect + super + + sections.push :header + sections.push :functions +rescue => error + puts error +end diff --git a/templates/default/includedirectory/html/headers_list.erb b/templates/default/includedirectory/html/headers_list.erb new file mode 100644 index 0000000..1b524aa --- /dev/null +++ b/templates/default/includedirectory/html/headers_list.erb @@ -0,0 +1 @@ +

All headers

diff --git a/templates/default/includedirectory/html/setup.rb b/templates/default/includedirectory/html/setup.rb new file mode 100644 index 0000000..5945ae4 --- /dev/null +++ b/templates/default/includedirectory/html/setup.rb @@ -0,0 +1,10 @@ +def init + super + sections.push :headers_list + + @namespace = object +end + +def headers + object.headers +end diff --git a/templates/default/layout/html/setup.rb b/templates/default/layout/html/setup.rb new file mode 100644 index 0000000..c6e52d2 --- /dev/null +++ b/templates/default/layout/html/setup.rb @@ -0,0 +1,41 @@ +def init + super +end + +# +# Append yard-cucumber stylesheet to yard core stylesheets +# +def stylesheets + super + %w(css/mruby.css) +end + +# +# Append yard-cucumber javascript to yard core javascripts +# +def javascripts + super + %w(js/mruby.js) +end + +# +# Append yard-cucumber specific menus 'features' and 'tags' +# +# 'features' and 'tags' are enabled by default. +# +# 'step definitions' and 'steps' may be enabled by setting up a value in +# yard configuration file '~/.yard/config' +# +# @example `~/.yard.config` +# +# yard-cucumber: +# menus: [ 'features', 'directories', 'tags', 'step definitions', 'steps' ] +# +def menu_lists + + [ { + type: 'header', + title: 'C API', + search_title: 'C API' + } ] + super + +end + -- cgit v1.2.3