Update documentation to 0.10.0

weavejester · Nov 7, 2024 · 5d83975 · 5d83975
1 parent 277363e
commit 5d83975
Show file tree

Hide file tree

Showing 14 changed files with 228 additions and 39 deletions.
diff --git a/css/default.css b/css/default.css
@@ -21,6 +21,14 @@ h2 {
     font-size: 25px;
 }
 
+h5.license {
+    margin: 9px 0 22px 0;
+    color: #555;
+    font-weight: normal;
+    font-size: 12px;
+    font-style: italic;
+}
+
 .document h1, .namespace-index h1 {
     font-size: 32px;
     margin-top: 12px;
@@ -433,49 +441,56 @@ p {
 }
 
 .markdown p, .markdown li, .markdown dt, .markdown dd, .markdown td {
-    line-height: 18px;
+    line-height: 22px;
+}
+
+.markdown li {
+    padding: 2px 0;
 }
 
 .markdown h2 {
     font-weight: normal;
     font-size: 25px;
+    margin: 30px 0 10px 0;
 }
 
-#content .markdown h3 {
+.markdown h3 {
+    font-weight: normal;
     font-size: 20px;
+    margin: 30px 0 0 0;
 }
 
 .markdown h4 {
     font-size: 15px;
+    margin: 22px 0 -4px 0;
 }
 
 .doc, .public, .namespace .index {
     max-width: 680px;
     overflow-x: visible;
 }
 
-.markdown code, .src-link a {
-    background: #f6f6f6;
+.markdown pre > code {
+    display: block;
+    padding: 10px;
+}
+
+.markdown pre > code, .src-link a {
     border: 1px solid #e4e4e4;
     border-radius: 2px;
 }
 
-.markdown pre, pre.deps {
-    background: #f4f4f4;
-    border: 1px solid #e0e0e0;
-    border-radius: 2px;
-    padding: 5px 10px;
-    margin: 15px 10px;
+.markdown code:not(.hljs), .src-link a {
+    background: #f6f6f6;
 }
 
 pre.deps {
     display: inline-block;
     margin: 0 10px;
-}
-
-.markdown pre code {
-    background: transparent;
-    border: none;
+    border: 1px solid #e4e4e4;
+    border-radius: 2px;
+    padding: 10px;
+    background-color: #f6f6f6;
 }
 
 .markdown hr {

diff --git a/css/highlight.css b/css/highlight.css
@@ -0,0 +1,97 @@
+/*
+github.com style (c) Vasily Polovnyov <[email protected]>
+*/
+
+.hljs {
+  display: block;
+  overflow-x: auto;
+  padding: 0.5em;
+  color: #333;
+  background: #f8f8f8;
+}
+
+.hljs-comment,
+.hljs-quote {
+  color: #998;
+  font-style: italic;
+}
+
+.hljs-keyword,
+.hljs-selector-tag,
+.hljs-subst {
+  color: #333;
+  font-weight: bold;
+}
+
+.hljs-number,
+.hljs-literal,
+.hljs-variable,
+.hljs-template-variable,
+.hljs-tag .hljs-attr {
+  color: #008080;
+}
+
+.hljs-string,
+.hljs-doctag {
+  color: #d14;
+}
+
+.hljs-title,
+.hljs-section,
+.hljs-selector-id {
+  color: #900;
+  font-weight: bold;
+}
+
+.hljs-subst {
+  font-weight: normal;
+}
+
+.hljs-type,
+.hljs-class .hljs-title {
+  color: #458;
+  font-weight: bold;
+}
+
+.hljs-tag,
+.hljs-name,
+.hljs-attribute {
+  color: #000080;
+  font-weight: normal;
+}
+
+.hljs-regexp,
+.hljs-link {
+  color: #009926;
+}
+
+.hljs-symbol,
+.hljs-bullet {
+  color: #990073;
+}
+
+.hljs-built_in,
+.hljs-builtin-name {
+  color: #0086b3;
+}
+
+.hljs-meta {
+  color: #999;
+  font-weight: bold;
+}
+
+.hljs-deletion {
+  background: #fdd;
+}
+
+.hljs-addition {
+  background: #dfd;
+}
+
+.hljs-emphasis {
+  font-style: italic;
+}
+
+.hljs-strong {
+  font-weight: bold;
+}
diff --git a/index.html b/index.html
@@ -1,4 +1,4 @@
 <!DOCTYPE html PUBLIC ""
     "">
-<html><head><meta charset="UTF-8" /><link href="css/default.css" rel="stylesheet" type="text/css" /><script src="js/jquery.min.js" type="text/javascript"></script><script src="js/page_effects.js" type="text/javascript"></script><title>Ragtime 0.6.0</title></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">Ragtime</span> <span class="project-version">0.6.0</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"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>ragtime</span></div></div></li><li class="depth-2 branch"><a href="ragtime.core.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>core</span></div></a></li><li class="depth-2 branch"><a href="ragtime.jdbc.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>jdbc</span></div></a></li><li class="depth-2 branch"><a href="ragtime.protocols.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>protocols</span></div></a></li><li class="depth-2 branch"><a href="ragtime.repl.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>repl</span></div></a></li><li class="depth-2"><a href="ragtime.strategy.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>strategy</span></div></a></li></ul></div><div class="namespace-index" id="content"><h1><span class="project-title"><span class="project-name">Ragtime</span> <span class="project-version">0.6.0</span></span></h1><div class="doc"><p>A database-independent migration library.</p></div><h2>Installation</h2><p>To install, add the following dependency to your project or build file:</p><pre class="deps">[ragtime "0.6.0"]</pre><h2>Namespaces</h2><div class="namespace"><h3><a href="ragtime.core.html">ragtime.core</a></h3><div class="doc"><pre class="plaintext">Functions for applying and rolling back migrations.</pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="ragtime.core.html#var-applied-migrations">applied-migrations</a> </li><li> <a href="ragtime.core.html#var-into-index">into-index</a> </li><li> <a href="ragtime.core.html#var-migrate">migrate</a> </li><li> <a href="ragtime.core.html#var-migrate-all">migrate-all</a> </li><li> <a href="ragtime.core.html#var-rollback">rollback</a> </li><li> <a href="ragtime.core.html#var-rollback-last">rollback-last</a> </li><li> <a href="ragtime.core.html#var-rollback-to">rollback-to</a> </li></ul></div></div><div class="namespace"><h3><a href="ragtime.jdbc.html">ragtime.jdbc</a></h3><div class="doc"><pre class="plaintext">Functions for loading SQL migrations and applying them to a SQL database.</pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="ragtime.jdbc.html#var-load-directory">load-directory</a> </li><li> <a href="ragtime.jdbc.html#var-load-files">load-files</a> </li><li> <a href="ragtime.jdbc.html#var-load-resources">load-resources</a> </li><li> <a href="ragtime.jdbc.html#var-sql-database">sql-database</a> </li><li> <a href="ragtime.jdbc.html#var-sql-migration">sql-migration</a> </li></ul></div></div><div class="namespace"><h3><a href="ragtime.protocols.html">ragtime.protocols</a></h3><div class="doc"><pre class="plaintext"></pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="ragtime.protocols.html#var-DataStore">DataStore</a> </li><li> <a href="ragtime.protocols.html#var-Migration">Migration</a> </li></ul></div></div><div class="namespace"><h3><a href="ragtime.repl.html">ragtime.repl</a></h3><div class="doc"><pre class="plaintext">Convenience functions for running in the REPL.</pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="ragtime.repl.html#var-default-reporter">default-reporter</a> </li><li> <a href="ragtime.repl.html#var-migrate">migrate</a> </li><li> <a href="ragtime.repl.html#var-migration-index">migration-index</a> </li><li> <a href="ragtime.repl.html#var-rollback">rollback</a> </li></ul></div></div><div class="namespace"><h3><a href="ragtime.strategy.html">ragtime.strategy</a></h3><div class="doc"><pre class="plaintext">Algorithms for managing conflicts between migrations applied to a database,
-and migrations that we want to apply to the database.</pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="ragtime.strategy.html#var-apply-new">apply-new</a> </li><li> <a href="ragtime.strategy.html#var-raise-error">raise-error</a> </li><li> <a href="ragtime.strategy.html#var-rebase">rebase</a> </li></ul></div></div></div></body></html>
+<html><head><meta charset="UTF-8" /><title>Ragtime 0.10.0</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">Ragtime</span> <span class="project-version">0.10.0</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"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>ragtime</span></div></div></li><li class="depth-2 branch"><a href="ragtime.core.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>core</span></div></a></li><li class="depth-2"><a href="ragtime.jdbc.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>jdbc</span></div></a></li><li class="depth-3"><a href="ragtime.jdbc.migrations.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>migrations</span></div></a></li><li class="depth-2 branch"><a href="ragtime.next-jdbc.html"><div class="inner"><span class="tree" style="top: -52px;"><span class="top" style="height: 61px;"></span><span class="bottom"></span></span><span>next-jdbc</span></div></a></li><li class="depth-2 branch"><a href="ragtime.protocols.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>protocols</span></div></a></li><li class="depth-2 branch"><a href="ragtime.repl.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>repl</span></div></a></li><li class="depth-2 branch"><a href="ragtime.reporter.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>reporter</span></div></a></li><li class="depth-2"><a href="ragtime.sql.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>sql</span></div></a></li><li class="depth-3"><a href="ragtime.sql.compiler.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>compiler</span></div></a></li><li class="depth-2"><a href="ragtime.strategy.html"><div class="inner"><span class="tree" style="top: -52px;"><span class="top" style="height: 61px;"></span><span class="bottom"></span></span><span>strategy</span></div></a></li></ul></div><div class="namespace-index" id="content"><h1><span class="project-title"><span class="project-name">Ragtime</span> <span class="project-version">0.10.0</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>A database-independent migration library.</p></div><h2>Installation</h2><p>To install, add the following dependency to your project or build file:</p><pre class="deps">[dev.weavejester/ragtime "0.10.0"]</pre><h2>Namespaces</h2><div class="namespace"><h3><a href="ragtime.core.html">ragtime.core</a></h3><div class="doc"><pre class="plaintext">Functions for applying and rolling back migrations.</pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="ragtime.core.html#var-applied-migrations">applied-migrations</a> </li><li> <a href="ragtime.core.html#var-into-index">into-index</a> </li><li> <a href="ragtime.core.html#var-migrate">migrate</a> </li><li> <a href="ragtime.core.html#var-migrate-all">migrate-all</a> </li><li> <a href="ragtime.core.html#var-rollback">rollback</a> </li><li> <a href="ragtime.core.html#var-rollback-last">rollback-last</a> </li><li> <a href="ragtime.core.html#var-rollback-to">rollback-to</a> </li></ul></div></div><div class="namespace"><h3><a href="ragtime.jdbc.html">ragtime.jdbc</a></h3><div class="doc"><pre class="plaintext">Functions for loading SQL migrations and applying them to a SQL database.</pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="ragtime.jdbc.html#var-load-directory">load-directory</a> </li><li> <a href="ragtime.jdbc.html#var-load-resources">load-resources</a> </li><li> <a href="ragtime.jdbc.html#var-sql-database">sql-database</a> </li><li> <a href="ragtime.jdbc.html#var-sql-migration">sql-migration</a> </li></ul></div></div><div class="namespace"><h3><a href="ragtime.jdbc.migrations.html">ragtime.jdbc.migrations</a></h3><div class="doc"><pre class="plaintext"></pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="ragtime.jdbc.migrations.html#var-create-table">create-table</a> </li></ul></div></div><div class="namespace"><h3><a href="ragtime.next-jdbc.html">ragtime.next-jdbc</a></h3><div class="doc"><pre class="plaintext">Functions for loading SQL migrations and applying them to a SQL database.</pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="ragtime.next-jdbc.html#var-load-directory">load-directory</a> </li><li> <a href="ragtime.next-jdbc.html#var-load-resources">load-resources</a> </li><li> <a href="ragtime.next-jdbc.html#var-sql-database">sql-database</a> </li><li> <a href="ragtime.next-jdbc.html#var-sql-migration">sql-migration</a> </li></ul></div></div><div class="namespace"><h3><a href="ragtime.protocols.html">ragtime.protocols</a></h3><div class="doc"><pre class="plaintext">Protocols for defining a migration and data store.</pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="ragtime.protocols.html#var-DataStore">DataStore</a> </li><li> <a href="ragtime.protocols.html#var-Migration">Migration</a> </li></ul></div></div><div class="namespace"><h3><a href="ragtime.repl.html">ragtime.repl</a></h3><div class="doc"><pre class="plaintext">Convenience functions for running in the REPL.</pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="ragtime.repl.html#var-migrate">migrate</a> </li><li> <a href="ragtime.repl.html#var-migration-index">migration-index</a> </li><li> <a href="ragtime.repl.html#var-rollback">rollback</a> </li></ul></div></div><div class="namespace"><h3><a href="ragtime.reporter.html">ragtime.reporter</a></h3><div class="doc"><pre class="plaintext">Functions for reporting on migrations that are applied or rolled back.</pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="ragtime.reporter.html#var-print">print</a> </li><li> <a href="ragtime.reporter.html#var-silent">silent</a> </li></ul></div></div><div class="namespace"><h3><a href="ragtime.sql.html">ragtime.sql</a></h3><div class="doc"><pre class="plaintext"></pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="ragtime.sql.html#var-load-directory">load-directory</a> </li><li> <a href="ragtime.sql.html#var-load-file-seq">load-file-seq</a> </li><li> <a href="ragtime.sql.html#var-load-migrations">load-migrations</a> </li><li> <a href="ragtime.sql.html#var-load-resources">load-resources</a> </li><li> <a href="ragtime.sql.html#var-ToURI">ToURI</a> </li></ul></div></div><div class="namespace"><h3><a href="ragtime.sql.compiler.html">ragtime.sql.compiler</a></h3><div class="doc"><pre class="plaintext"></pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="ragtime.sql.compiler.html#var-compile">compile</a> </li><li> <a href="ragtime.sql.compiler.html#var-gen-id">gen-id</a> </li></ul></div></div><div class="namespace"><h3><a href="ragtime.strategy.html">ragtime.strategy</a></h3><div class="doc"><pre class="plaintext">Algorithms for managing conflicts between migrations applied to a database,
+and migrations that we want to apply to the database.</pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="ragtime.strategy.html#var-apply-new">apply-new</a> </li><li> <a href="ragtime.strategy.html#var-ignore-future">ignore-future</a> </li><li> <a href="ragtime.strategy.html#var-raise-error">raise-error</a> </li><li> <a href="ragtime.strategy.html#var-rebase">rebase</a> </li></ul></div></div></div></body></html>