Skip to content

Commit

Permalink
Added generated docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
@ryugi
ryugi committed May 23, 2017
1 parent d43c53d commit f6d5d05
Show file tree
Hide file tree
Showing 139 changed files with 3,694 additions and 2 deletions.
26 changes: 25 additions & 1 deletion project.clj
View file
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,27 @@
:profiles {
:uberjar {
:aot [#"timi.server.*" #"timi.config.*"]}
:docs {
:aot :all
:dependencies [[systems.billo/superhero-codox-theme "0.3.0-SNAPSHOT"]]
:plugins [
[lein-codox "0.10.3"]]}
:server-docs {
:codox {
:project {:name "Tímı"}
:themes [:superhero]
:output-path "resources/public/static/docs/api/server/current"
:doc-paths ["resources/docs/api"]
:metadata {:doc/format :markdown}}}
:client-docs {
:codox {
:project {:name "Tímı"}
:themes [:superhero]
:language :clojurescript
:source-paths ["src/cljs"]
:output-path "resources/public/static/docs/api/client/current"
:doc-paths ["resources/docs/api"]
:metadata {:doc/format :markdown}}}
:dev [{
:dependencies [
[binaryage/devtools "0.9.4"]
Expand Down Expand Up @@ -149,4 +170,7 @@
["compile"]
["uberjar"]
["cljsbuild" "once"]]
"timi-deploy" ["with-profile" "build" "deploy" "clojars"]})
"timi-deploy" ["with-profile" "build" "deploy" "clojars"]
"timi-server-docs" ["with-profile" "+build,+docs,+server-docs" "codox"]
"timi-client-docs" ["with-profile" "+build,+docs,+client-docs" "codox"]
"timi-docs" ["do" ["timi-server-docs"] ["timi-client-docs"]]})
7 changes: 7 additions & 0 deletions resources/docs/api/90-all-versions.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# All Versions

Below are linked the most recent version of the API reference, as well as all
previous ones:

* [current](index.html)
* [0.3.0](../v0.3.0/index.html)
3 changes: 2 additions & 1 deletion resources/docs/overview.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@ The following docs are available for Tímı:
* [Time Entry](docs/user/time-entry)
* [User Settings](docs/user/settings)
* **DEVELOPMENT**
* [API Reference](docs/url) - Codox-generated source code documentation
* [Server API Reference](/static/docs/api/server/current/index.html) - Codox-generated documentation from the Clojure source code
* [Client API Reference](/static/docs/api/client/current/index.html) - Codox-generated documentation from the ClojureScript source code
* **DESIGN / UX**
* [Bootswatch Theme](/static/bootswatch/theme.html)
* [Bootstrap CSS](/static/bootstrap/css.html)
Expand Down
8 changes: 8 additions & 0 deletions resources/public/static/docs/api/client/current/90-all-versions.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<!DOCTYPE html PUBLIC ""
"">
<html><head><meta charset="UTF-8" /><title>All Versions</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="highlight/paraiso-dark.css" /><script type="text/javascript" src="highlight/highlight.pack.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> with the <a href="https://github.com/billosys/superhero-codox-theme">Bootswatch Superhero</a> theme</h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Tímı</span> <span class="project-version">0.3.0-SNAPSHOT</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">Topics</span></h3><ul><li class="depth-1 current"><a href="90-all-versions.html"><div class="inner"><span>All Versions</span></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>time</span></div></div></li><li class="depth-2"><a href="time.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-1"><div class="no-link"><div class="inner"><span class="tree" style="top: -52px;"><span class="top" style="height: 61px;"></span><span class="bottom"></span></span><span>timi</span></div></div></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>client</span></div></div></li><li class="depth-3 branch"><a href="timi.client.actions.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>actions</span></div></a></li><li class="depth-3"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>activity</span></div></div></li><li class="depth-4"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>graphic</span></div></div></li><li class="depth-5 branch"><a href="timi.client.activity.graphic.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-5 branch"><a href="timi.client.activity.graphic.data.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>data</span></div></a></li><li class="depth-5 branch"><a href="timi.client.activity.graphic.draw.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>draw</span></div></a></li><li class="depth-5"><a href="timi.client.activity.graphic.grid.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>grid</span></div></a></li><li class="depth-3 branch"><a href="timi.client.core.html"><div class="inner"><span class="tree" style="top: -176px;"><span class="top" style="height: 185px;"></span><span class="bottom"></span></span><span>core</span></div></a></li><li class="depth-3"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>day</span></div></div></li><li class="depth-4"><a href="timi.client.day.table.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>table</span></div></a></li><li class="depth-3 branch"><a href="timi.client.logging.html"><div class="inner"><span class="tree" style="top: -52px;"><span class="top" style="height: 61px;"></span><span class="bottom"></span></span><span>logging</span></div></a></li><li class="depth-3"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>time</span></div></div></li><li class="depth-4 branch"><a href="timi.client.time.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-4 branch"><a href="timi.client.time.form.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>form</span></div></a></li><li class="depth-4 branch"><a href="timi.client.time.project.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>project</span></div></a></li><li class="depth-4"><a href="timi.client.time.state.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>state</span></div></a></li><li class="depth-3"><a href="timi.client.util.html"><div class="inner"><span class="tree" style="top: -145px;"><span class="top" style="height: 154px;"></span><span class="bottom"></span></span><span>util</span></div></a></li></ul></div><div class="document" id="content"><div class="doc"><div class="markdown"><h1><a href="#all-versions" name="all-versions"></a>All Versions</h1>
<p>Below are linked the most recent version of the API reference, as well as all previous ones:</p>
<ul>
<li><a href="index.html">current</a></li>
<li><a href="../v0.3.0/index.html">0.3.0</a></li>
</ul></div></div></div></body></html>
Loading

0 comments on commit f6d5d05

Please sign in to comment.