Module YARD::Server::DocServerHelper
In: lib/yard/server/doc_server_helper.rb

A module that is mixed into {Templates::Template} in order to customize certain template methods.

Methods

Public Instance methods

@example The base path for a library ‘foo‘

  base_path('docs') # => 'docs/foo'

@param [String] path the path prefix for a base path URI @return [String] the base URI for a library with an extra path prefix

@return [Router] convenience method for accessing the router

Modifies {Templates::Helpers::HtmlHelper#url_for} to return a URL instead of a disk location. @param (see Templates::Helpers::HtmlHelper#url_for) @return (see Templates::Helpers::HtmlHelper#url_for)

Modifies {Templates::Helpers::HtmlHelper#url_for_file} to return a URL instead of a disk location. @param (see Templates::Helpers::HtmlHelper#url_for_file) @return (see Templates::Helpers::HtmlHelper#url_for_file)

Returns the frames URL for the page @return (see Templates::Helpers::HtmlHelper#url_for_frameset)

Returns the URL for the alphabetic index page @return (see Templates::Helpers::HtmlHelper#url_for_index)

Modifies {Templates::Helpers::HtmlHelper#url_for_list} to return a URL based on the list prefix instead of a HTML filename. @param (see Templates::Helpers::HtmlHelper#url_for_list) @return (see Templates::Helpers::HtmlHelper#url_for_list)

Returns the main URL, first checking a readme and then linking to the index @return (see Templates::Helpers::HtmlHelper#url_for_main)

[Validate]