sleeping_king_studios-docs 0.1.0

data/lib/sleeping_king_studios/docs/templates/pages/index.md.erb

@@ -0,0 +1,22 @@
+---
+breadcrumbs:
+  - name: Documentation
+    path: './'
+---
+
+# <%= name %>
+
+<%= description %>
+
+## Documentation
+
+This is the documentation for the [current development build](<%= repository %>) of <%= name %>.
+
+<!-- - For the most recent release, see [Version 0.1]({{site.baseurl}}/versions/0.1). -->
+- For previous releases, see the [Versions]({{site.baseurl}}/versions) page.
+
+## Reference
+
+For a full list of defined classes and objects, see [Reference](./reference).
+
+{% include breadcrumbs.md %}

data/lib/sleeping_king_studios/docs/templates/pages/reference.md.erb

@@ -0,0 +1,14 @@
+---
+breadcrumbs:
+  - name: Documentation
+    path: '../'
+version: '*'
+---
+
+{% assign root_namespace = site.namespaces | where: "version", page.version | first %}
+
+# <%= name %> Reference
+
+{% include reference/namespace.md label=false namespace=root_namespace %}
+
+{% include breadcrumbs.md %}

data/lib/sleeping_king_studios/docs/templates/pages/versions.md.erb

@@ -0,0 +1,13 @@
+---
+breadcrumbs:
+  - name: Documentation
+    path: '../'
+---
+
+# Versions
+
+For more information on release versions, see the [Changelog](<%= repository %>/blob/main/CHANGELOG.md).
+
+<!-- - [Version 0.1]({{site.baseurl}}/versions/0.1) -->
+
+{% include breadcrumbs.md %}

data/lib/sleeping_king_studios/docs/version.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module SleepingKingStudios
+  module Docs
+    # @api private
+    #
+    # The current version of the gem.
+    #
+    # @see http://semver.org/
+    module Version
+      # Major version.
+      MAJOR = 0
+      # Minor version.
+      MINOR = 1
+      # Patch version.
+      PATCH = 0
+      # Prerelease version.
+      PRERELEASE = nil
+      # Build metadata.
+      BUILD = nil
+
+      class << self
+        # Generates the gem version string from the Version constants.
+        #
+        # Inlined here because dependencies may not be loaded when processing a
+        # gemspec, which results in the user being unable to install the gem for
+        # the first time.
+        #
+        # @see SleepingKingStudios::Tools::SemanticVersion#to_gem_version
+        def to_gem_version
+          str = "#{MAJOR}.#{MINOR}.#{PATCH}"
+
+          prerelease = value_of(:PRERELEASE)
+          str = "#{str}.#{prerelease}" if prerelease
+
+          build = value_of(:BUILD)
+          str = "#{str}.#{build}" if build
+
+          str
+        end
+
+        private
+
+        def value_of(constant)
+          return nil unless const_defined?(constant)
+
+          value = const_get(constant)
+
+          return nil if value.respond_to?(:empty?) && value.empty?
+
+          value
+        end
+      end
+    end
+
+    # The current version of the gem.
+    VERSION = Version.to_gem_version
+  end
+end

data/lib/sleeping_king_studios/docs.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# Hic iacet Arthurus, rex quondam, rexque futurus.
+module SleepingKingStudios
+  # Tooling for working with YARD documentation.
+  module Docs
+    class << self
+      # @return [String] the absolute path to the gem directory.
+      def gem_path
+        pattern = /#{File.join('', 'lib', 'sleeping_king_studios', '')}?\z/
+
+        __dir__.sub(pattern, '')
+      end
+
+      # @return [String] The current version of the gem.
+      def version
+        VERSION
+      end
+    end
+
+    autoload :Commands,      'sleeping_king_studios/docs/commands'
+    autoload :Data,          'sleeping_king_studios/docs/data'
+    autoload :Errors,        'sleeping_king_studios/docs/errors'
+    autoload :Registry,      'sleeping_king_studios/docs/registry'
+    autoload :RegistryQuery, 'sleeping_king_studios/docs/registry_query'
+  end
+end

metadata

@@ -0,0 +1,243 @@
+--- !ruby/object:Gem::Specification
+name: sleeping_king_studios-docs
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rob "Merlin" Smith
+bindir: bin
+cert_chain: []
+date: 2025-03-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cuprum
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: erubi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: sleeping_king_studios-tools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: treetop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: |-
+  SleepingKingStudios::Docs provides a CLI and tooling for generating a static
+  website from your YARD documentation, powered by Jekyll.
+email:
+- merlin@sleepingkingstudios.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE
+- README.md
+- lib/sleeping_king_studios/docs.rb
+- lib/sleeping_king_studios/docs/commands.rb
+- lib/sleeping_king_studios/docs/commands/generate.rb
+- lib/sleeping_king_studios/docs/commands/generators.rb
+- lib/sleeping_king_studios/docs/commands/generators/base.rb
+- lib/sleeping_king_studios/docs/commands/generators/data_generator.rb
+- lib/sleeping_king_studios/docs/commands/generators/reference_generator.rb
+- lib/sleeping_king_studios/docs/commands/installation.rb
+- lib/sleeping_king_studios/docs/commands/installation/install_jekyll.rb
+- lib/sleeping_king_studios/docs/commands/installation/install_templates.rb
+- lib/sleeping_king_studios/docs/commands/installation/install_workflow.rb
+- lib/sleeping_king_studios/docs/commands/parse.rb
+- lib/sleeping_king_studios/docs/commands/write_file.rb
+- lib/sleeping_king_studios/docs/data.rb
+- lib/sleeping_king_studios/docs/data/base.rb
+- lib/sleeping_king_studios/docs/data/class_object.rb
+- lib/sleeping_king_studios/docs/data/constant_object.rb
+- lib/sleeping_king_studios/docs/data/metadata.rb
+- lib/sleeping_king_studios/docs/data/method_object.rb
+- lib/sleeping_king_studios/docs/data/module_object.rb
+- lib/sleeping_king_studios/docs/data/namespace_object.rb
+- lib/sleeping_king_studios/docs/data/root_object.rb
+- lib/sleeping_king_studios/docs/data/see_tags.rb
+- lib/sleeping_king_studios/docs/data/see_tags/base.rb
+- lib/sleeping_king_studios/docs/data/see_tags/class_method_tag.rb
+- lib/sleeping_king_studios/docs/data/see_tags/constant_tag.rb
+- lib/sleeping_king_studios/docs/data/see_tags/definition_tag.rb
+- lib/sleeping_king_studios/docs/data/see_tags/instance_method_tag.rb
+- lib/sleeping_king_studios/docs/data/see_tags/link_tag.rb
+- lib/sleeping_king_studios/docs/data/see_tags/namespace_item_tag.rb
+- lib/sleeping_king_studios/docs/data/see_tags/reference_tag.rb
+- lib/sleeping_king_studios/docs/data/see_tags/text_tag.rb
+- lib/sleeping_king_studios/docs/data/see_tags/unstructured_tag.rb
+- lib/sleeping_king_studios/docs/data/types.rb
+- lib/sleeping_king_studios/docs/data/types/grammar.treetop
+- lib/sleeping_king_studios/docs/data/types/key_value_type.rb
+- lib/sleeping_king_studios/docs/data/types/parameterized_type.rb
+- lib/sleeping_king_studios/docs/data/types/parser.rb
+- lib/sleeping_king_studios/docs/data/types/type.rb
+- lib/sleeping_king_studios/docs/errors.rb
+- lib/sleeping_king_studios/docs/errors/file_already_exists.rb
+- lib/sleeping_king_studios/docs/errors/file_error.rb
+- lib/sleeping_king_studios/docs/errors/file_not_found.rb
+- lib/sleeping_king_studios/docs/errors/invalid_directory.rb
+- lib/sleeping_king_studios/docs/errors/invalid_file.rb
+- lib/sleeping_king_studios/docs/registry.rb
+- lib/sleeping_king_studios/docs/registry_query.rb
+- lib/sleeping_king_studios/docs/tasks.rb
+- lib/sleeping_king_studios/docs/tasks/base.rb
+- lib/sleeping_king_studios/docs/tasks/generate.rb
+- lib/sleeping_king_studios/docs/tasks/installation.rb
+- lib/sleeping_king_studios/docs/tasks/installation/install_jekyll.rb
+- lib/sleeping_king_studios/docs/tasks/installation/install_templates.rb
+- lib/sleeping_king_studios/docs/tasks/installation/install_workflow.rb
+- lib/sleeping_king_studios/docs/tasks/update.rb
+- lib/sleeping_king_studios/docs/templates/config.yml.erb
+- lib/sleeping_king_studios/docs/templates/deploy-pages.yml.erb
+- lib/sleeping_king_studios/docs/templates/includes/breadcrumbs.md
+- lib/sleeping_king_studios/docs/templates/includes/reference/attribute.md
+- lib/sleeping_king_studios/docs/templates/includes/reference/attributes/heading.md
+- lib/sleeping_king_studios/docs/templates/includes/reference/class.md
+- lib/sleeping_king_studios/docs/templates/includes/reference/constant.md
+- lib/sleeping_king_studios/docs/templates/includes/reference/constants/heading.md
+- lib/sleeping_king_studios/docs/templates/includes/reference/constants/inherited.md
+- lib/sleeping_king_studios/docs/templates/includes/reference/constants/overview.md
+- lib/sleeping_king_studios/docs/templates/includes/reference/definitions/breadcrumbs.md
+- lib/sleeping_king_studios/docs/templates/includes/reference/definitions/class_attributes.md
+- lib/sleeping_king_studios/docs/templates/includes/reference/definitions/class_methods.md
+- lib/sleeping_king_studios/docs/templates/includes/reference/definitions/constants.md
+- lib/sleeping_king_studios/docs/templates/includes/reference/definitions/constructor.md
+- lib/sleeping_king_studios/docs/templates/includes/reference/definitions/definitions.md
+- lib/sleeping_king_studios/docs/templates/includes/reference/definitions/details.md
+- lib/sleeping_king_studios/docs/templates/includes/reference/definitions/instance_attributes.md
+- lib/sleeping_king_studios/docs/templates/includes/reference/definitions/instance_methods.md
+- lib/sleeping_king_studios/docs/templates/includes/reference/definitions/overview.md
+- lib/sleeping_king_studios/docs/templates/includes/reference/definitions/subclasses.md
+- lib/sleeping_king_studios/docs/templates/includes/reference/definitions/table-of-contents.md
+- lib/sleeping_king_studios/docs/templates/includes/reference/definitions/table-of-contents/class_attributes.md
+- lib/sleeping_king_studios/docs/templates/includes/reference/definitions/table-of-contents/class_methods.md
+- lib/sleeping_king_studios/docs/templates/includes/reference/definitions/table-of-contents/constants.md
+- lib/sleeping_king_studios/docs/templates/includes/reference/definitions/table-of-contents/instance_attributes.md
+- lib/sleeping_king_studios/docs/templates/includes/reference/definitions/table-of-contents/instance_methods.md
+- lib/sleeping_king_studios/docs/templates/includes/reference/definitions/table-of-contents/overview.md
+- lib/sleeping_king_studios/docs/templates/includes/reference/method.md
+- lib/sleeping_king_studios/docs/templates/includes/reference/methods/aliases.md
+- lib/sleeping_king_studios/docs/templates/includes/reference/methods/heading.md
+- lib/sleeping_king_studios/docs/templates/includes/reference/methods/inherited.md
+- lib/sleeping_king_studios/docs/templates/includes/reference/methods/overload.md
+- lib/sleeping_king_studios/docs/templates/includes/reference/methods/overloads.md
+- lib/sleeping_king_studios/docs/templates/includes/reference/methods/overview.md
+- lib/sleeping_king_studios/docs/templates/includes/reference/methods/parameters.md
+- lib/sleeping_king_studios/docs/templates/includes/reference/methods/post_overview.md
+- lib/sleeping_king_studios/docs/templates/includes/reference/methods/raises.md
+- lib/sleeping_king_studios/docs/templates/includes/reference/methods/return_types.md
+- lib/sleeping_king_studios/docs/templates/includes/reference/methods/returns.md
+- lib/sleeping_king_studios/docs/templates/includes/reference/methods/yields.md
+- lib/sleeping_king_studios/docs/templates/includes/reference/module.md
+- lib/sleeping_king_studios/docs/templates/includes/reference/namespace.md
+- lib/sleeping_king_studios/docs/templates/includes/reference/parent_link.md
+- lib/sleeping_king_studios/docs/templates/includes/reference/reference_link.md
+- lib/sleeping_king_studios/docs/templates/includes/reference/see_link.md
+- lib/sleeping_king_studios/docs/templates/includes/reference/type.md
+- lib/sleeping_king_studios/docs/templates/includes/reference/type_list.md
+- lib/sleeping_king_studios/docs/templates/includes/reference/types/array_type.md
+- lib/sleeping_king_studios/docs/templates/includes/reference/types/hash_type.md
+- lib/sleeping_king_studios/docs/templates/includes/reference/types/ordered_type.md
+- lib/sleeping_king_studios/docs/templates/pages/index.md.erb
+- lib/sleeping_king_studios/docs/templates/pages/reference.md.erb
+- lib/sleeping_king_studios/docs/templates/pages/versions.md.erb
+- lib/sleeping_king_studios/docs/version.rb
+homepage: http://sleepingkingstudios.com
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/sleepingkingstudios/sleeping_king_studios-docs/issues
+  source_code_uri: https://github.com/sleepingkingstudios/sleeping_king_studios-docs
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.5
+specification_version: 4
+summary: Tools for generating a versioned documentation site from YARD docs.
+test_files: []