sleeping_king_studios-docs 0.1.0

data/lib/sleeping_king_studios/docs/templates/includes/reference/definitions/instance_methods.md

@@ -0,0 +1,17 @@
+{% if include.definition.constructor and include.definition.instance_methods.size > 1 %}
+## Instance Methods
+{% elsif include.definition.instance_methods.size > 0 %}
+## Instance Methods
+{% endif %}
+
+{% for instance_method in include.definition.instance_methods %}
+{% unless instance_method.constructor %}
+{% include reference/method.md name=instance_method.name path=instance_method.path type="instance" inherited=instance_method.inherited %}
+{% endunless %}
+{% endfor %}
+
+{% if include.definition.constructor and include.definition.instance_methods.size > 1 %}
+[Back To Top](#)
+{% elsif include.definition.instance_methods.size > 0 %}
+[Back To Top](#)
+{% endif %}

data/lib/sleeping_king_studios/docs/templates/includes/reference/definitions/overview.md

@@ -0,0 +1,74 @@
+## Overview
+
+{% if include.definition.metadata.deprecated %}
+> **Deprecated.** {{ include.definition.metadata.deprecated }}
+{% endif %}
+
+{% if include.definition.metadata.abstract %}
+> **This {{ include.definition.type }} is abstract.** {{ include.definition.metadata.abstract }}
+{% endif %}
+
+{% if include.definition.metadata.todos.size > 0 %}
+{% for todo in include.definition.metadata.todos %}
+> **Todo:** {{ todo }}
+{% endfor %}
+{% endif %}
+
+{% if include.definition.metadata.notes.size > 0 %}
+{% for note in include.definition.metadata.notes %}
+> *Note:* {{ note }}
+{% endfor %}
+{% endif %}
+
+{% if include.definition.short_description %}
+{{ include.definition.short_description }}
+{% endif %}
+
+{% if include.definition.description %}
+{{ include.definition.description }}
+{% endif %}
+
+{% if include.definition.metadata.examples.size > 0 %}
+### Examples
+
+{% for example in include.definition.metadata.examples %}
+{% if example.name.size > 0 %}**{{ example.name }}**{% endif %}
+{% highlight ruby %}
+{{ example.text }}
+{% endhighlight %}
+{% endfor %}
+{% endif %}
+
+{% if include.definition.metadata.see.size > 0 %}
+### See Also
+
+{% for see in include.definition.metadata.see %}
+- {% include reference/see_link.md see=see -%}
+{% endfor %}
+{% endif %}
+
+{% if include.definition.metadata.authors.size > 0 %}
+### Author{% if include.definition.metadata.authors.size > 1 %}s{% endif %}
+
+{% for author in include.definition.metadata.authors %}
+- {{ author -}}
+{% endfor %}
+{% endif %}
+
+{% if include.definition.metadata.since.size > 0 %}
+### Since
+
+{% for since in include.definition.metadata.since %}
+- {{ since -}}
+{% endfor %}
+{% endif %}
+
+{% if include.definition.metadata.versions.size > 0 %}
+### Version{% if include.definition.metadata.versions.size > 1 %}s{% endif %}
+
+{% for version in include.definition.metadata.versions %}
+- {{ version -}}
+{% endfor %}
+{% endif %}
+
+[Back To Top](#)

data/lib/sleeping_king_studios/docs/templates/includes/reference/definitions/subclasses.md

@@ -0,0 +1,10 @@
+{% if include.definition.direct_subclasses.size > 0 %}
+## Direct Subclasses
+
+{% for subclass in include.definition.direct_subclasses -%}
+{% include reference/reference_link.md label=subclass.name path=subclass.path -%}
+{% unless forloop.last %}, {% endunless %}
+{%- endfor %}
+
+[Back To Top](#)
+{% endif %}

data/lib/sleeping_king_studios/docs/templates/includes/reference/definitions/table-of-contents/class_attributes.md

@@ -0,0 +1,10 @@
+{% if include.definition.class_attributes.size > 0 %}
+<li>
+  <a href="#class-attributes">Class Attributes</a>
+  <ul style="margin-bottom: 0px;">
+  {% for attribute in include.definition.class_attributes %}
+    <li><a href="#class-attribute-{{ attribute.slug | replace: "=", "--equals" }}">{{ attribute.name }}</a></li>
+  {% endfor %}
+  </ul>
+</li>
+{% endif %}

data/lib/sleeping_king_studios/docs/templates/includes/reference/definitions/table-of-contents/class_methods.md

@@ -0,0 +1,10 @@
+{% if include.definition.class_methods.size > 0 %}
+<li>
+  <a href="#class-methods">Class Methods</a>
+  <ul style="margin-bottom: 0px;">
+  {% for method in include.definition.class_methods %}
+    <li><a href="#class-method-{{ method.slug | replace: "=", "--equals" | replace: "?", "--predicate" }}">{{ method.name }}</a></li>
+  {% endfor %}
+  </ul>
+</li>
+{% endif %}

data/lib/sleeping_king_studios/docs/templates/includes/reference/definitions/table-of-contents/constants.md

@@ -0,0 +1,10 @@
+{% if include.definition.constants.size > 0 %}
+<li>
+  <a href="#constants">Constants</a>
+  <ul style="margin-bottom: 0px;">
+  {% for constant in include.definition.constants %}
+    <li><a href="#constant-{{ constant.slug }}">{{ constant.name }}</a></li>
+  {% endfor %}
+  </ul>
+</li>
+{% endif %}

data/lib/sleeping_king_studios/docs/templates/includes/reference/definitions/table-of-contents/instance_attributes.md

@@ -0,0 +1,10 @@
+{% if include.definition.instance_attributes.size > 0 %}
+<li>
+  <a href="#instance-attributes">Instance Attributes</a>
+  <ul style="margin-bottom: 0px;">
+  {% for attribute in include.definition.instance_attributes %}
+    <li><a href="#instance-attribute-{{ attribute.slug | replace: "=", "--equals" }}">{{ attribute.name }}</a></li>
+  {% endfor %}
+  </ul>
+</li>
+{% endif %}

data/lib/sleeping_king_studios/docs/templates/includes/reference/definitions/table-of-contents/instance_methods.md

@@ -0,0 +1,10 @@
+{% if include.definition.instance_methods.size > 0 %}
+<li>
+  <a href="#instance-methods">Instance Methods</a>
+  <ul style="margin-bottom: 0px;">
+  {% for method in include.definition.instance_methods %}
+    <li><a href="#instance-method-{{ method.slug | replace: "=", "--equals" | replace: "?", "--predicate" }}">{{ method.name }}</a></li>
+  {% endfor %}
+  </ul>
+</li>
+{% endif %}

data/lib/sleeping_king_studios/docs/templates/includes/reference/definitions/table-of-contents/overview.md

@@ -0,0 +1,41 @@
+<li>
+  <a href="#overview">Overview</a>
+  {% assign metadata = include.definition.metadata %}
+  {% if metadata.examples.size > 0 or metadata.see.size > 0 or metadata.authors.size > 0 or metadata.since.size > 0 or metadata.versions.size > 0 %}
+  <ul style="margin-bottom: 0px;">
+    {% if metadata.examples.size > 0 %}
+    <li>
+      <a href="#examples">Examples</a>
+    </li>
+    {% endif %}
+    {% if metadata.see.size > 0 %}
+    <li>
+      <a href="#see-also">See Also</a>
+    </li>
+    {% endif %}
+    {% if metadata.authors.size > 1 %}
+    <li>
+      <a href="#authors">Authors</a>
+    </li>
+    {% elsif metadata.authors.size > 0 %}
+    <li>
+      <a href="#author">Author</a>
+    </li>
+    {% endif %}
+    {% if metadata.since.size > 0 %}
+    <li>
+      <a href="#since">Since</a>
+    </li>
+    {% endif %}
+    {% if metadata.versions.size > 1 %}
+    <li>
+      <a href="#versions">Versions</a>
+    </li>
+    {% elsif metadata.versions.size > 0 %}
+    <li>
+      <a href="#version">Version</a>
+    </li>
+    {% endif %}
+  </ul>
+  {% endif %}
+</li>

data/lib/sleeping_king_studios/docs/templates/includes/reference/definitions/table-of-contents.md

@@ -0,0 +1,27 @@
+## Table Of Contents
+
+<ul>
+  {% include reference/definitions/table-of-contents/overview.md definition=include.definition %}
+
+  {% if include.definition.direct_subclasses.size > 0 %}
+  <li><a href="#direct-subclasses">Direct Subclasses</a></li>
+  {% endif %}
+
+  {% if include.definition.defined_classes.size > 0 or include.definitions.defined_modules.size > 0 %}
+  <li><a href="#defined-under-namespace">Defined Under Namespace</a></li>
+  {% endif %}
+
+  {% include reference/definitions/table-of-contents/constants.md definition=include.definition %}
+
+  {% include reference/definitions/table-of-contents/class_attributes.md definition=include.definition %}
+
+  {% include reference/definitions/table-of-contents/class_methods.md definition=include.definition %}
+
+  {% if include.definition.constructor %}
+  <li><a href="#constructor">Constructor</a></li>
+  {% endif %}
+
+  {% include reference/definitions/table-of-contents/instance_attributes.md definition=include.definition %}
+
+  {% include reference/definitions/table-of-contents/instance_methods.md definition=include.definition %}
+</ul>

data/lib/sleeping_king_studios/docs/templates/includes/reference/method.md

@@ -0,0 +1,27 @@
+{% assign method = site.methods | where: "data_path", include.path | where: "version", page.version | first %}
+{% if method %}
+{% capture prefix %}{{ include.type }}-method{% endcapture %}
+{% capture heading_id %}{{ prefix }}-{{ method.slug | replace: "=", "--equals" | replace: "?", "--predicate" }}{% endcapture %}
+
+{% include reference/methods/heading.md heading_id=heading_id method=method type=include.type %}
+
+{% include reference/methods/aliases.md method=method %}
+
+{% include reference/methods/inherited.md inherited=include.inherited method=method %}
+
+{% include reference/methods/overview.md heading_id=heading_id method=method %}
+
+{% include reference/methods/overloads.md heading_id=heading_id method=method %}
+
+{% include reference/methods/parameters.md heading_id=heading_id method=method %}
+
+{% include reference/methods/yields.md heading_id=heading_id method=method %}
+
+{% include reference/methods/returns.md heading_id=heading_id method=method %}
+
+{% include reference/methods/raises.md heading_id=heading_id method=method %}
+
+{% include reference/methods/post_overview.md heading_id=heading_id method=method %}
+{% else %}
+### Missing Method: {{ include.path }} @ {{ page.version }}
+{% endif %}

data/lib/sleeping_king_studios/docs/templates/includes/reference/methods/aliases.md

@@ -0,0 +1,4 @@
+{% if include.method.aliases.size > 0 %}
+*Also known as:*
+{% for alias in include.method.aliases %}<code>{{ alias }}</code>{%- unless forloop.last %}, {% endunless -%}{% endfor %}
+{% endif %}

data/lib/sleeping_king_studios/docs/templates/includes/reference/methods/heading.md

@@ -0,0 +1,14 @@
+{% capture char %}{% if include.type == "class" %}.{% else %}#{% endif %}{% endcapture %}
+{% capture abstract %}{% if include.method.metadata.abstract %} <small>(abstract)</small>{% endif %}{% endcapture %}
+{% capture deprecated %}{% if include.method.metadata.deprecated %} <small>(deprecated)</small>{% endif %}{% endcapture %}
+
+<h3>
+  {% if include.method.overloads.size > 0 %}
+  {% for overload in method.overloads %}
+  <code>{{ char }}{{ overload.signature }} => {% include reference/methods/return_types.md method=overload -%}{{ abstract }}{{ deprecated }}</code>{% unless forloop.last %}<br />{% endunless %}
+  {%- endfor -%}
+  {%- else -%}
+  <code>{{ char }}{{ include.method.signature }} => {% include reference/methods/return_types.md method=include.method -%}{{ abstract }}{{ deprecated }}</code>
+  {% endif -%}
+</h3>
+{: #{{ include.heading_id }} }

data/lib/sleeping_king_studios/docs/templates/includes/reference/methods/inherited.md

@@ -0,0 +1,4 @@
+{% if include.inherited %}
+{% if include.type == "class" %}Extended{% else %}Inherited{% endif %} From
+: {% include reference/parent_link.md parent_path=include.method.parent_path %}
+{% endif %}

data/lib/sleeping_king_studios/docs/templates/includes/reference/methods/overload.md

@@ -0,0 +1,18 @@
+{% capture overload_id %}{{ include.heading_id }}--overload-{{ include.index }}{% endcapture %}
+
+<h5>
+  <code>{{ char }}{{ include.overload.signature }} => {% include reference/methods/return_types.md method=include.overload -%}</code>
+</h5>
+{: #{{ overload_id }} }
+
+{% include reference/methods/overview.md heading_id=overload_id method=overload overload=true %}
+
+{% include reference/methods/parameters.md heading_id=overload_id method=overload overload=true %}
+
+{% include reference/methods/yields.md heading_id=overload_id method=overload overload=true %}
+
+{% include reference/methods/returns.md heading_id=overload_id method=overload overload=true %}
+
+{% include reference/methods/raises.md heading_id=overload_id method=overload overload=true %}
+
+{% include reference/methods/post_overview.md heading_id=overload_id method=overload overload=true %}

data/lib/sleeping_king_studios/docs/templates/includes/reference/methods/overloads.md

@@ -0,0 +1,12 @@
+{% if include.method.overloads.size > 0 %}
+#### Overloads
+{: #{{ include.heading_id }}--overloads }
+
+{% for overload in include.method.overloads %}
+<div class="overload" style="margin-left: 2rem;">
+  {% assign index = forloop.index %}
+  {% capture rendered %}{% include reference/methods/overload.md heading_id=heading_id index=index overload=overload %}{% endcapture %}
+{{ rendered | strip | markdownify }}
+</div>
+{% endfor %}
+{% endif %}

data/lib/sleeping_king_studios/docs/templates/includes/reference/methods/overview.md

@@ -0,0 +1,41 @@
+{% if include.method.metadata.deprecated %}
+> **Deprecated.** {{ include.method.metadata.deprecated }}
+{% endif %}
+
+{% if include.method.metadata.abstract %}
+> **This method is abstract.** {{ include.method.metadata.abstract }}
+{% endif %}
+
+{% if include.method.metadata.todos.size > 0 %}
+{% for todo in include.method.metadata.todos %}
+> **Todo:** {{ todo }}
+{% endfor %}
+{% endif %}
+
+{% if include.method.metadata.notes.size > 0 %}
+{% for note in include.method.metadata.notes %}
+> *Note:* {{ note }}
+{% endfor %}
+{% endif %}
+
+{% if include.method.short_description %}
+{{ include.method.short_description }}
+{% endif %}
+
+{% if include.method.description %}
+{{ include.method.description }}
+{% endif %}
+
+{% if include.method.metadata.examples.size > 0 %}
+{% if include.overload %}
+###### Examples
+{: #{{ include.heading_id }}--examples }
+{% else %}
+#### Examples
+{: #{{ include.heading_id }}--examples }
+{% endif %}
+{% for example in include.method.metadata.examples %}
+{% if example.name.size > 0 %}**{{ example.name }}**{% endif %}
+{% highlight ruby %}{{ example.text }}{% endhighlight %}
+{% endfor %}
+{% endif %}

data/lib/sleeping_king_studios/docs/templates/includes/reference/methods/parameters.md

@@ -0,0 +1,31 @@
+{% if include.method.params %}
+{% if include.overload %}
+###### Parameters
+{: #{{ include.heading_id }}--parameters }
+{% else %}
+#### Parameters
+{: #{{ include.heading_id }}--parameters }
+{% endif %}
+<ul>
+{% for param in include.method.params -%}
+<li><strong>{{ param.name }}</strong> {% if param.type.size > 0 %}({%- include reference/type_list.md types=param.type -%}){% endif %}{% if param.description.size > 0 %} — {{ param.description }}{% endif %}</li>
+{%- endfor %}
+</ul>
+{% endif %}
+
+{% if include.method.options.size > 0 %}
+{% for options in include.method.options %}
+{% if include.overload %}
+###### Options Hash ({{ options.name }})
+{: #{{ include.heading_id }}--options-{{ options.name }} }
+{% else %}
+#### Options Hash ({{ options.name }})
+{: #{{ include.heading_id }}--options-{{ options.name }} }
+{% endif %}
+<ul>
+{% for option in options.opts -%}
+<li><strong>{{ option.name -}}</strong> {% if option.type.size > 0 %}({%- include reference/type_list.md types=option.type -%}){% endif %}{% if option.description.size > 0 %} — {{ option.description }}{% endif %}</li>
+{%- endfor %}
+</ul>
+{% endfor %}
+{% endif %}

data/lib/sleeping_king_studios/docs/templates/includes/reference/methods/post_overview.md

@@ -0,0 +1,51 @@
+{% if include.method.metadata.see.size > 0 %}
+{% if include.overload %}
+###### See Also
+{: #{{ include.heading_id }}--see-also }
+{% else %}
+#### See Also
+{: #{{ include.heading_id }}--see-also }
+{% endif %}
+{% for see in include.method.metadata.see %}
+- {% include reference/see_link.md see=see -%}
+{% endfor %}
+{% endif %}
+
+{% if include.method.metadata.authors.size > 0 %}
+{% if include.overload %}
+###### Author{% if include.method.metadata.authors.size > 1 %}s{% endif %}
+{: #{{ include.heading_id }}--authors }
+{% else %}
+#### Author{% if include.method.metadata.authors.size > 1 %}s{% endif %}
+{: #{{ include.heading_id }}--authors }
+{% endif %}
+{% for author in include.method.metadata.authors %}
+- {{ author -}}
+{% endfor %}
+{% endif %}
+
+{% if include.method.metadata.since.size > 0 %}
+{% if include.overload %}
+###### Since
+{: #{{ include.heading_id }}--since }
+{% else %}
+#### Since
+{: #{{ include.heading_id }}--since }
+{% endif %}
+{% for since in include.method.metadata.since %}
+- {{ since -}}
+{% endfor %}
+{% endif %}
+
+{% if include.method.metadata.versions.size > 0 %}
+{% if include.overload %}
+###### Version{% if include.method.metadata.versions.size > 1 %}s{% endif %}
+{: #{{ include.heading_id }}--versions }
+{% else %}
+#### Version{% if include.method.metadata.versions.size > 1 %}s{% endif %}
+{: #{{ include.heading_id }}--versions }
+{% endif %}
+{% for version in include.method.metadata.versions %}
+- {{ version -}}
+{% endfor %}
+{% endif %}

data/lib/sleeping_king_studios/docs/templates/includes/reference/methods/raises.md

@@ -0,0 +1,14 @@
+{% if include.method.raises.size > 0 %}
+{% if include.overload %}
+###### Raises
+{: #{{ include.heading_id }}--raises }
+{% else %}
+#### Raises
+{: #{{ include.heading_id }}--raises }
+{% endif %}
+<ul>
+{% for raised in include.method.raises -%}
+<li>({%- include reference/type_list.md types=raised.type -%}){% if raised.description.size > 0 %} — {{ raised.description }}{% endif %}</li>
+{%- endfor %}
+</ul>
+{% endif %}

data/lib/sleeping_king_studios/docs/templates/includes/reference/methods/return_types.md

@@ -0,0 +1,9 @@
+{%- if include.method.constructor -%}
+{{ include.method.returns.first.type.first.name | default: "Object" }}
+{%- elsif include.method.returns.size > 0 -%}
+{% for returns in include.method.returns %}
+{%- include reference/type_list.md types=returns.type -%}{%- unless forloop.last -%}, {% endunless -%}
+{% endfor %}
+{%- else -%}
+Object
+{%- endif -%}

data/lib/sleeping_king_studios/docs/templates/includes/reference/methods/returns.md

@@ -0,0 +1,14 @@
+{% if include.method.returns.size > 0 %}
+{% if include.overload %}
+###### Returns
+{: #{{ include.heading_id }}--returns }
+{% else %}
+#### Returns
+{: #{{ include.heading_id }}--returns }
+{% endif %}
+<ul>
+{% for return in include.method.returns -%}
+<li>({%- include reference/type_list.md types=return.type -%}){% if return.description.size > 0 %} — {{ return.description }}{% endif %}</li>
+{%- endfor %}
+</ul>
+{% endif %}

data/lib/sleeping_king_studios/docs/templates/includes/reference/methods/yields.md

@@ -0,0 +1,42 @@
+{% if include.method.yields.size > 0 %}
+{% if include.overload %}
+###### Yields
+{: #{{ include.heading_id }}--yields }
+{% else %}
+#### Yields
+{: #{{ include.heading_id }}--yields }
+{% endif %}
+{% for yielded in include.method.yields %}
+- {% if yielded.parameters.size > 0 %}({% for parameter in yielded.parameters %}{{ parameter }}{% unless forloop.last %}, {% endunless %}{% endfor %}){% if yielded.description.size > 0 %} — {% endif %}{% endif %}{% if yielded.description.size > 0 %}{{ yielded.description }}{% endif -%}
+{% endfor %}
+{% endif %}
+
+{% if include.method.yield_params.size > 0 %}
+{% if include.overload %}
+###### Yield Parameters
+{: #{{ include.heading_id }}--yield-parameters }
+{% else %}
+#### Yield Parameters
+{: #{{ include.heading_id }}--yield-parameters }
+{% endif %}
+<ul>
+{% for param in include.method.yield_params -%}
+<li><strong>{{ param.name -}}</strong> {% if param.type.size > 0 %}({%- include reference/type_list.md types=param.type -%}){% endif %}{% if param.description.size > 0 %} — {{ param.description }}{% endif %}</li>
+{%- endfor %}
+</ul>
+{% endif %}
+
+{% if include.method.yield_returns.size > 0 %}
+{% if include.overload %}
+###### Yield Returns
+{: #{{ include.heading_id }}--yield-returns }
+{% else %}
+#### Yield Returns
+{: #{{ include.heading_id }}--yield-returns }
+{% endif %}
+<ul>
+{% for return in include.method.yield_returns -%}
+<li>{% if return.type.size > 0 %}({%- include reference/type_list.md types=return.type -%}){% endif %}{% if return.type.size > 0 and return.description.size > 0 %} — {% endif %}{% if return.description.size > 0 %}{{ return.description }}{% endif %}</li>
+{%- endfor %}
+</ul>
+{% endif %}

data/lib/sleeping_king_studios/docs/templates/includes/reference/module.md

@@ -0,0 +1,23 @@
+{% assign definition = site.modules | where: "data_path", page.data_path | where: "version", page.version | first %}
+
+# Module: {{ definition.name }}
+
+{% include reference/definitions/details.md definition=definition %}
+
+{% include reference/definitions/table-of-contents.md definition=definition %}
+
+{% include reference/definitions/overview.md definition=definition %}
+
+{% include reference/definitions/definitions.md definition=definition %}
+
+{% include reference/definitions/constants.md definition=definition %}
+
+{% include reference/definitions/class_attributes.md definition=definition %}
+
+{% include reference/definitions/class_methods.md definition=definition %}
+
+{% include reference/definitions/instance_attributes.md definition=definition %}
+
+{% include reference/definitions/instance_methods.md definition=definition %}
+
+{% include reference/definitions/breadcrumbs.md definition=definition %}

data/lib/sleeping_king_studios/docs/templates/includes/reference/namespace.md

@@ -0,0 +1,33 @@
+{% if include.label %}
+  {% assign reference_label = include.namespace.name | split: "::" | last %}
+  {% include reference/reference_link.md label=reference_label path=include.namespace.data_path -%}
+  {% if include.namespace.type == "class" %}
+  {% assign parent_class = include.namespace.inherited_classes.first %}
+  < {% if parent_class %}{% include reference/reference_link.md label=parent_class.name path=parent_class.path %}{% else %}Object{% endif %}
+  {% endif %}
+{% endif %}
+
+{% assign empty_array = "" | split: "," %}
+{% assign defined_classes = include.namespace.defined_classes | default: empty_array %}
+{% assign defined_modules = include.namespace.defined_modules | default: empty_array %}
+{% assign definitions = defined_classes | concat: defined_modules | sort: "name" %}
+{% if definitions.size > 0 %}
+<ul style="margin-bottom: 0px;">
+{% for definition in definitions %}
+  <li>
+    {% capture data_path %}
+      {{- include.namespace.data_path -}}
+      {% if include.namespace.data_path.size > 0 %}/{% endif %}
+      {{- definition.slug -}}
+    {% endcapture %}
+    {% assign matched = site.modules | where: "data_path", data_path | where: "version", include.namespace.version | first %}
+    {% unless matched %}
+      {% assign matched = site.classes | where: "data_path", data_path | where: "version", include.namespace.version | first %}
+    {% endunless %}
+    {% include reference/namespace.md label=true namespace=matched -%}
+  </li>
+{% endfor %}
+</ul>
+{% else %}
+{% unless include.label %}This namespace does not define any classes or modules.{% endunless %}
+{% endif %}

data/lib/sleeping_king_studios/docs/templates/includes/reference/parent_link.md

@@ -0,0 +1,6 @@
+{% capture parent_link %}
+{% assign parent_definition = site.classes | where: "data_path", include.parent_path | where: "version", page.version | first %}
+{% unless parent_definition %}{% assign parent_definition = site.modules | where: "data_path", include.parent_path | where: "version", page.version | first %}{% endunless %}
+{% if parent_definition %}{% include reference/reference_link.md label=parent_definition.name path=parent_definition.data_path -%}{% else %}Object{% endif %}
+{% endcapture %}
+{{ parent_link | strip }}

data/lib/sleeping_king_studios/docs/templates/includes/reference/reference_link.md

@@ -0,0 +1,7 @@
+{% capture version_path %}{% unless page.version == "*" %}/versions/{{ page.version }}{% endunless %}{% endcapture %}
+{%- if include.path %}
+{%- capture url %}{{ site.baseurl }}{{ version_path | strip }}/reference/{{ include.path }}{% endcapture -%}
+<a href="{{ url }}">{{ include.label }}</a>
+{%- else -%}
+{{ include.label -}}
+{% endif -%}

data/lib/sleeping_king_studios/docs/templates/includes/reference/see_link.md

@@ -0,0 +1,7 @@
+{%- if include.see.type == 'link' -%}
+[{{ include.see.label }}]({{include.see.path}}) {{ include.see.text }}
+{%- elsif include.see.type == 'reference' -%}
+{% include reference/reference_link.md label=include.see.label path=include.see.path %} {{ include.see.text }}
+{%- else -%}
+{{ include.see.text }}
+{%- endif -%}

data/lib/sleeping_king_studios/docs/templates/includes/reference/type.md

@@ -0,0 +1,14 @@
+{% capture formatted %}
+{%- if include.type.items %}
+{%- if include.type.ordered %}
+{%- include reference/types/ordered_type.md type=include.type -%}
+{%- else -%}
+{%- include reference/types/array_type.md type=include.type -%}
+{%- endif -%}
+{% elsif include.type.keys %}
+{%- include reference/types/hash_type.md type=include.type -%}
+{% else %}
+{%- include reference/reference_link.md label=include.type.name path=include.type.path -%}
+{% endif -%}
+{% endcapture %}
+{{- formatted | strip -}}

data/lib/sleeping_king_studios/docs/templates/includes/reference/type_list.md

@@ -0,0 +1,4 @@
+{% capture formatted %}
+{% for type in include.types %}{% include reference/type.md type=type -%}{%- unless forloop.last %}, {% endunless -%}{% endfor %}
+{% endcapture %}
+{{- formatted | strip -}}

data/lib/sleeping_king_studios/docs/templates/includes/reference/types/array_type.md

@@ -0,0 +1 @@
+{%- include reference/reference_link.md label=include.type.name path=include.type.path -%}<{% include reference/type_list.md types=include.type.items %}>

data/lib/sleeping_king_studios/docs/templates/includes/reference/types/hash_type.md

@@ -0,0 +1 @@
+{%- include reference/reference_link.md label=include.type.name path=include.type.path -%}{{% include reference/type_list.md types=include.type.keys %} => {% include reference/type_list.md types=include.type.values %}}

data/lib/sleeping_king_studios/docs/templates/includes/reference/types/ordered_type.md

@@ -0,0 +1 @@
+{%- include reference/reference_link.md label=include.type.name path=include.type.path -%}<({% include reference/type_list.md types=include.type.items %})>