Create various rake tasks to generate documentation and various assets for versions specified in config[:all_versions].

Create a rake task to generate a docs_config.js file with all versions specified in config[:all_versions].

Create a rake task to generate documentation for versions specified in config[:all_versions].

Create a rake task to generate an index.html file redirecting to the first version in config[:all_versions].

Create a yard rake task used to generate documentation for the current version of a project, using Kit::Doc::Yard setup.

• :config - A Kit::Doc config object.

• :task_name - The name of the rake task. Defaults to 'documentation:generate'.

• :clean_output_dir - If true, it will run a recursive remove inside :output_dir_current_version/*. Defaults to false as it is potentially dangerous.

Generate a docs_config.js file for all versions in config[:all_versions].

docs_config.js

This file is used as cheap way to provide the documentation js logic the list of all known documentation versions.

A default one is added when generating documentation for a given version, and can then be overwriten by the version generated here.

versionNodes

This global JavaScript variable should be providing an array of objects that define all versions of this project which should appear in the project versions dropdown in the documentation sidebar. The versions dropdown allows # for switching between package versions' documentation.

Example:

var versionNodes = [
  {
    version: "v0.1.0", // version number or name (required)
    url: "https://docs.rubykit.org/kit-doc/0.1.0/" // documentation URL (required)
  }
]

Run rake documentation:generate for all config[:all_versions] after checking out the git reference.

Generate a html redirect file.

• :dst - Absolute path for the new file.

• :title - Html title.

• :redirect_url - The url to redirect to.