Merge branch '45-api-docs' into 'master'

45 -- Add API Documentation

See merge request Mordil/swift-redis-nio-client!48

Author: Mordil

.gitlab-ci.yml

@@ -8,9 +8,28 @@ pages:
   only:
     - tags
   tags:
-    - private-xcode
-  script:
-    - "echo 'TODO #45 -- Publish API Docs'"
+    - private-macOS
+  script: |
+    version=$(git describe --abbrev=0 --tags || echo "0.0.0")
+    swift build
+    sourcekitten doc --spm-module "RedisNIO" > ./RedisNIO.json
+    swift package generate-xcodeproj
+    jazzy --clean \
+          --author "Nathan Harris (Mordil)" \
+          --readme "./README.md" \
+          --author_url "https://mordil.info" \
+          --github_url "https://gitlab.com/mordil/swift-redis-nio-client" \
+          --github-file-prefix https://gitlab.com/mordil/swift-redis-nio-client/blob/$version \
+          --root-url "https://mordil.gitlab.io/swift-redis-nio-client/docs/RedisNIO" \
+          --module "RedisNIO" \
+          --module-version "$version" \
+          --theme fullwidth \
+          --xcodebuild-arguments -scheme,swift-redis-nio-client-Package \
+          --sourcekitten-sourcefile "./RedisNIO.json" \
+          --output "./public"
+  artifacts:
+    paths:
+      - public
 
 .build:
   stage: build release

docs/theme/assets/css/highlight.css.scss

@@ -0,0 +1,63 @@
+/* Credit to https://gist.github.com/wataru420/2048287 */
+
+.highlight {
+  .c { color: #999988; font-style: italic } /* Comment */
+  .err { color: #a61717; background-color: #e3d2d2 } /* Error */
+  .k { color: #000000; font-weight: bold } /* Keyword */
+  .o { color: #000000; font-weight: bold } /* Operator */
+  .cm { color: #999988; font-style: italic } /* Comment.Multiline */
+  .cp { color: #999999; font-weight: bold } /* Comment.Preproc */
+  .c1 { color: #999988; font-style: italic } /* Comment.Single */
+  .cs { color: #999999; font-weight: bold; font-style: italic } /* Comment.Special */
+  .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */
+  .gd .x { color: #000000; background-color: #ffaaaa } /* Generic.Deleted.Specific */
+  .ge { color: #000000; font-style: italic } /* Generic.Emph */
+  .gr { color: #aa0000 } /* Generic.Error */
+  .gh { color: #999999 } /* Generic.Heading */
+  .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */
+  .gi .x { color: #000000; background-color: #aaffaa } /* Generic.Inserted.Specific */
+  .go { color: #888888 } /* Generic.Output */
+  .gp { color: #555555 } /* Generic.Prompt */
+  .gs { font-weight: bold } /* Generic.Strong */
+  .gu { color: #aaaaaa } /* Generic.Subheading */
+  .gt { color: #aa0000 } /* Generic.Traceback */
+  .kc { color: #000000; font-weight: bold } /* Keyword.Constant */
+  .kd { color: #000000; font-weight: bold } /* Keyword.Declaration */
+  .kp { color: #000000; font-weight: bold } /* Keyword.Pseudo */
+  .kr { color: #000000; font-weight: bold } /* Keyword.Reserved */
+  .kt { color: #445588; } /* Keyword.Type */
+  .m { color: #009999 } /* Literal.Number */
+  .s { color: #d14 } /* Literal.String */
+  .na { color: #008080 } /* Name.Attribute */
+  .nb { color: #0086B3 } /* Name.Builtin */
+  .nc { color: #445588; font-weight: bold } /* Name.Class */
+  .no { color: #008080 } /* Name.Constant */
+  .ni { color: #800080 } /* Name.Entity */
+  .ne { color: #990000; font-weight: bold } /* Name.Exception */
+  .nf { color: #990000; } /* Name.Function */
+  .nn { color: #555555 } /* Name.Namespace */
+  .nt { color: #000080 } /* Name.Tag */
+  .nv { color: #008080 } /* Name.Variable */
+  .ow { color: #000000; font-weight: bold } /* Operator.Word */
+  .w { color: #bbbbbb } /* Text.Whitespace */
+  .mf { color: #009999 } /* Literal.Number.Float */
+  .mh { color: #009999 } /* Literal.Number.Hex */
+  .mi { color: #009999 } /* Literal.Number.Integer */
+  .mo { color: #009999 } /* Literal.Number.Oct */
+  .sb { color: #d14 } /* Literal.String.Backtick */
+  .sc { color: #d14 } /* Literal.String.Char */
+  .sd { color: #d14 } /* Literal.String.Doc */
+  .s2 { color: #d14 } /* Literal.String.Double */
+  .se { color: #d14 } /* Literal.String.Escape */
+  .sh { color: #d14 } /* Literal.String.Heredoc */
+  .si { color: #d14 } /* Literal.String.Interpol */
+  .sx { color: #d14 } /* Literal.String.Other */
+  .sr { color: #009926 } /* Literal.String.Regex */
+  .s1 { color: #d14 } /* Literal.String.Single */
+  .ss { color: #990073 } /* Literal.String.Symbol */
+  .bp { color: #999999 } /* Name.Builtin.Pseudo */
+  .vc { color: #008080 } /* Name.Variable.Class */
+  .vg { color: #008080 } /* Name.Variable.Global */
+  .vi { color: #008080 } /* Name.Variable.Instance */
+  .il { color: #009999 } /* Literal.Number.Integer.Long */
+}