Merge pull request #29 from circleci/codox-test

stig · web-flow · commit 2e54775f2297 · 2024-03-19T20:55:41.000Z
Add a CI job to test that docs generation works
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -24,6 +24,22 @@ jobs:
           paths:
             - "~/.m2"
 
+  docs:
+    <<: *defaults
+    steps:
+      - checkout
+
+      - restore_cache:
+          keys:
+            - v1-m2-{{ .Branch }}-{{ checksum "project.clj" }}
+
+      - run: lein codox
+
+      - save_cache:
+          key: v1-m2-{{ .Branch }}-{{ checksum "project.clj" }}
+          paths:
+            - "~/.m2"
+
   test:
     <<: *defaults
     steps:
@@ -61,6 +77,7 @@ workflows:
   build_and_test:
     jobs:
       - build
+      - docs
       - test:
           requires:
             - build
diff --git a/docs/circleci.analytics-clj.core.html b/docs/circleci.analytics-clj.core.html
@@ -1,6 +1,6 @@
 <!DOCTYPE html PUBLIC ""
     "">
-<html><head><meta charset="UTF-8" /><title>circleci.analytics-clj.core documentation</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Analytics-clj</span> <span class="project-version">0.8.1</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 "><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1 current"><a href="circleci.analytics-clj.core.html"><div class="inner"><span>circleci.analytics-clj.core</span></div></a></li></ul></div><div class="sidebar secondary"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="circleci.analytics-clj.core.html#var-alias"><div class="inner"><span>alias</span></div></a></li><li class="depth-1"><a href="circleci.analytics-clj.core.html#var-enqueue"><div class="inner"><span>enqueue</span></div></a></li><li class="depth-1"><a href="circleci.analytics-clj.core.html#var-flush"><div class="inner"><span>flush</span></div></a></li><li class="depth-1"><a href="circleci.analytics-clj.core.html#var-group"><div class="inner"><span>group</span></div></a></li><li class="depth-1"><a href="circleci.analytics-clj.core.html#var-identify"><div class="inner"><span>identify</span></div></a></li><li class="depth-1"><a href="circleci.analytics-clj.core.html#var-initialize"><div class="inner"><span>initialize</span></div></a></li><li class="depth-1"><a href="circleci.analytics-clj.core.html#var-page"><div class="inner"><span>page</span></div></a></li><li class="depth-1"><a href="circleci.analytics-clj.core.html#var-screen"><div class="inner"><span>screen</span></div></a></li><li class="depth-1"><a href="circleci.analytics-clj.core.html#var-shutdown"><div class="inner"><span>shutdown</span></div></a></li><li class="depth-1"><a href="circleci.analytics-clj.core.html#var-track"><div class="inner"><span>track</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">circleci.analytics-clj.core</h1><div class="doc"><pre class="plaintext"></pre></div><div class="public anchor" id="var-alias"><h3>alias</h3><h4 class="added">added in 0.4.0</h4><div class="usage"><code>(alias analytics previous-id user-id)</code><code>(alias analytics previous-id user-id options)</code></div><div class="doc"><pre class="plaintext">`alias` is how you associate one identity with another.
+<html><head><meta charset="UTF-8" /><title>circleci.analytics-clj.core documentation</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Analytics-clj</span> <span class="project-version">0.8.2</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 "><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1 current"><a href="circleci.analytics-clj.core.html"><div class="inner"><span>circleci.analytics-clj.core</span></div></a></li></ul></div><div class="sidebar secondary"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="circleci.analytics-clj.core.html#var-alias"><div class="inner"><span>alias</span></div></a></li><li class="depth-1"><a href="circleci.analytics-clj.core.html#var-enqueue"><div class="inner"><span>enqueue</span></div></a></li><li class="depth-1"><a href="circleci.analytics-clj.core.html#var-flush"><div class="inner"><span>flush</span></div></a></li><li class="depth-1"><a href="circleci.analytics-clj.core.html#var-group"><div class="inner"><span>group</span></div></a></li><li class="depth-1"><a href="circleci.analytics-clj.core.html#var-identify"><div class="inner"><span>identify</span></div></a></li><li class="depth-1"><a href="circleci.analytics-clj.core.html#var-initialize"><div class="inner"><span>initialize</span></div></a></li><li class="depth-1"><a href="circleci.analytics-clj.core.html#var-page"><div class="inner"><span>page</span></div></a></li><li class="depth-1"><a href="circleci.analytics-clj.core.html#var-screen"><div class="inner"><span>screen</span></div></a></li><li class="depth-1"><a href="circleci.analytics-clj.core.html#var-shutdown"><div class="inner"><span>shutdown</span></div></a></li><li class="depth-1"><a href="circleci.analytics-clj.core.html#var-track"><div class="inner"><span>track</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">circleci.analytics-clj.core</h1><div class="doc"><pre class="plaintext"></pre></div><div class="public anchor" id="var-alias"><h3>alias</h3><h4 class="added">added in 0.4.0</h4><div class="usage"><code>(alias analytics previous-id user-id)</code><code>(alias analytics previous-id user-id options)</code></div><div class="doc"><pre class="plaintext">`alias` is how you associate one identity with another.
 This is an advanced method, but it is required to manage
 user identities successfully in some of our integrations.</pre></div></div><div class="public anchor" id="var-enqueue"><h3>enqueue</h3><h4 class="added">added in 0.4.0</h4><div class="usage"><code>(enqueue analytics message-builder)</code></div><div class="doc"><pre class="plaintext">Top-level `enqueue` function to allow for extensibility in the future.
 </pre></div></div><div class="public anchor" id="var-flush"><h3>flush</h3><h4 class="added">added in 0.4.0</h4><div class="usage"><code>(flush analytics)</code></div><div class="doc"><pre class="plaintext">Flush events in the message queue.
@@ -17,4 +17,4 @@
 extra information about the screen being viewed.</pre></div></div><div class="public anchor" id="var-shutdown"><h3>shutdown</h3><h4 class="added">added in 0.4.0</h4><div class="usage"><code>(shutdown analytics)</code></div><div class="doc"><pre class="plaintext">Stops this instance from processing further requests.
 </pre></div></div><div class="public anchor" id="var-track"><h3>track</h3><h4 class="added">added in 0.4.0</h4><div class="usage"><code>(track analytics user-id event)</code><code>(track analytics user-id event properties)</code><code>(track analytics user-id event properties options)</code></div><div class="doc"><pre class="plaintext">`track` lets you record the actions your users perform.
 Every action triggers what we call an “event”, which can
-also have associated properties.</pre></div></div></div></body></html>
+also have associated properties.</pre></div></div></div></body></html>
diff --git a/docs/index.html b/docs/index.html
@@ -1,3 +1,3 @@
 <!DOCTYPE html PUBLIC ""
     "">
-<html><head><meta charset="UTF-8" /><title>Analytics-clj 0.8.2</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Analytics-clj</span> <span class="project-version">0.8.2</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 current"><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1 "><a href="circleci.analytics-clj.core.html"><div class="inner"><span>circleci.analytics-clj.core</span></div></a></li></ul></div><div class="namespace-index" id="content"><h1><span class="project-title"><span class="project-name">Analytics-clj</span> <span class="project-version">0.8.2</span></span></h1><h5 class="license">Released under the <a href="http://www.eclipse.org/legal/epl-v10.html">Eclipse Public License</a></h5><div class="doc"><p>Idiomatic Clojure wrapper for the Segment.io 2.x Java client.</p></div><h2>Installation</h2><p>To install, add the following dependency to your project or build file:</p><pre class="deps">[circleci/analytics-clj "0.8.2"]</pre><h2>Namespaces</h2><div class="namespace"><h3><a href="circleci.analytics-clj.core.html">circleci.analytics-clj.core</a></h3><div class="doc"><pre class="plaintext"></pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="circleci.analytics-clj.core.html#var-alias">alias</a> </li><li> <a href="circleci.analytics-clj.core.html#var-enqueue">enqueue</a> </li><li> <a href="circleci.analytics-clj.core.html#var-flush">flush</a> </li><li> <a href="circleci.analytics-clj.core.html#var-group">group</a> </li><li> <a href="circleci.analytics-clj.core.html#var-identify">identify</a> </li><li> <a href="circleci.analytics-clj.core.html#var-initialize">initialize</a> </li><li> <a href="circleci.analytics-clj.core.html#var-page">page</a> </li><li> <a href="circleci.analytics-clj.core.html#var-screen">screen</a> </li><li> <a href="circleci.analytics-clj.core.html#var-shutdown">shutdown</a> </li><li> <a href="circleci.analytics-clj.core.html#var-track">track</a> </li></ul></div></div></div></body></html>
+<html><head><meta charset="UTF-8" /><title>Analytics-clj 0.8.2</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Analytics-clj</span> <span class="project-version">0.8.2</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 current"><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1 "><a href="circleci.analytics-clj.core.html"><div class="inner"><span>circleci.analytics-clj.core</span></div></a></li></ul></div><div class="namespace-index" id="content"><h1><span class="project-title"><span class="project-name">Analytics-clj</span> <span class="project-version">0.8.2</span></span></h1><h5 class="license">Released under the <a href="http://www.eclipse.org/legal/epl-v10.html">Eclipse Public License</a></h5><div class="doc"><p>Idiomatic Clojure wrapper for the Segment.io 2.x Java client.</p></div><h2>Installation</h2><p>To install, add the following dependency to your project or build file:</p><pre class="deps">[circleci/analytics-clj "0.8.2"]</pre><h2>Namespaces</h2><div class="namespace"><h3><a href="circleci.analytics-clj.core.html">circleci.analytics-clj.core</a></h3><div class="doc"><pre class="plaintext"></pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="circleci.analytics-clj.core.html#var-alias">alias</a> </li><li> <a href="circleci.analytics-clj.core.html#var-enqueue">enqueue</a> </li><li> <a href="circleci.analytics-clj.core.html#var-flush">flush</a> </li><li> <a href="circleci.analytics-clj.core.html#var-group">group</a> </li><li> <a href="circleci.analytics-clj.core.html#var-identify">identify</a> </li><li> <a href="circleci.analytics-clj.core.html#var-initialize">initialize</a> </li><li> <a href="circleci.analytics-clj.core.html#var-page">page</a> </li><li> <a href="circleci.analytics-clj.core.html#var-screen">screen</a> </li><li> <a href="circleci.analytics-clj.core.html#var-shutdown">shutdown</a> </li><li> <a href="circleci.analytics-clj.core.html#var-track">track</a> </li></ul></div></div></div></body></html>
