Files
RediStack/docs/theme/templates/doc.mustache
Nathan Harris dd839fdf02 45 -- Add API Documentation
Motivation:

Users need a quick reference available online that is up to date.

Modifications:

Add CI job to generate and publish API docs with Jazzy

Result:

Users can view API docs that are updated when new releases are tagged at https://mordil.gitlab.io/swift-redis-nio-client
2019-06-06 17:17:29 -07:00

60 lines
1.7 KiB
Plaintext

<!DOCTYPE html>
<html lang="en">
<head>
<title>{{name}} {{kind}} Reference</title>
<link rel="stylesheet" type="text/css" href="{{path_to_root}}css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="{{path_to_root}}css/highlight.css" />
<meta charset="utf-8">
<script src="{{path_to_root}}js/jquery.min.js" defer></script>
<script src="{{path_to_root}}js/jazzy.js" defer></script>
{{{custom_head}}}
{{^disable_search}}
<script src="{{path_to_root}}js/lunr.min.js" defer></script>
<script src="{{path_to_root}}js/typeahead.jquery.js" defer></script>
<script src="{{path_to_root}}js/jazzy.search.js" defer></script>
{{/disable_search}}
</head>
<body>
{{#dash_type}}
<a name="//apple_ref/{{language_stub}}/{{dash_type}}/{{name}}" class="dashAnchor"></a>
{{/dash_type}}
<a title="{{name}} {{kind}} Reference"></a>
{{> header}}
<p class="breadcrumbs">
<a class="breadcrumb" href="{{path_to_root}}index.html">{{module_name}} Reference</a>
<img class="carat" src="{{path_to_root}}img/carat.png" />
{{name}} {{kind}} Reference
</p>
<div class="content-wrapper">
{{> nav}}
<article class="main-content">
<section class="section">
<div class="section-content">
{{^hide_name}}<h1>{{name}}</h1>{{/hide_name}}
{{> deprecation}}
{{#declaration}}
<div class="declaration">
<div class="language">
{{{declaration}}}
</div>
</div>
{{/declaration}}
{{{overview}}}
</div>
</section>
{{> tasks}}
</article>
</div>
{{> footer}}
</body>
</div>
</html>