Module: SleepingKingStudios::Docs

Defined in:
lib/sleeping_king_studios/docs.rb,
lib/sleeping_king_studios/docs/data.rb,
lib/sleeping_king_studios/docs/tasks.rb,
lib/sleeping_king_studios/docs/errors.rb,
lib/sleeping_king_studios/docs/jekyll.rb,
lib/sleeping_king_studios/docs/version.rb,
lib/sleeping_king_studios/docs/commands.rb,
lib/sleeping_king_studios/docs/registry.rb,
lib/sleeping_king_studios/docs/tasks/base.rb,
lib/sleeping_king_studios/docs/registry_query.rb

Overview

Tooling for working with YARD documentation.

Defined Under Namespace

Modules: Commands, Data, Errors, Jekyll, Registry, Tasks, Version Classes: RegistryQuery

Constant Summary collapse

VERSION =

The current version of the gem.

Version.to_gem_version

Class Method Summary collapse

Class Method Details

.gem_pathString

Returns the absolute path to the gem directory.

Returns:

  • (String)

    the absolute path to the gem directory.



9
10
11
12
13
# File 'lib/sleeping_king_studios/docs.rb', line 9

def gem_path
  pattern = /#{File.join('', 'lib', 'sleeping_king_studios', '')}?\z/

  __dir__.sub(pattern, '')
end

.versionString

Returns The current version of the gem.

Returns:

  • (String)

    The current version of the gem.



16
17
18
# File 'lib/sleeping_king_studios/docs.rb', line 16

def version
  VERSION
end