File tree Expand file tree Collapse file tree 6 files changed +53
-5
lines changed Expand file tree Collapse file tree 6 files changed +53
-5
lines changed Original file line number Diff line number Diff line change
1
+ name : Build Codox Docs
2
+
3
+ on :
4
+ workflow_dispatch :
5
+
6
+ jobs :
7
+
8
+ build :
9
+ runs-on : ubuntu-latest
10
+ steps :
11
+
12
+ - name : Set up Java
13
+ uses : actions/setup-java@v3
14
+ with :
15
+ java-version : 8
16
+ distribution : ' temurin'
17
+
18
+ - name : Set up Clojure
19
+ uses :
DeLaGuardo/[email protected]
20
+ with :
21
+ cli : ' latest'
22
+
23
+ - name : Cache clojure dependencies
24
+ uses : actions/cache@v3
25
+ with :
26
+ path : |
27
+ ~/.m2/repository
28
+ ~/.gitlibs
29
+ key : cljdeps-${{ hashFiles('deps.edn') }}
30
+ restore-keys : cljdeps-
31
+
32
+ - name : Clone the repo
33
+ uses : actions/checkout@v4
34
+
35
+ - name : Install rlwrap
36
+ run : sudo apt-get install -y rlwrap
37
+
38
+ - name : Execute doc build
39
+ run : |
40
+ clj -X:docs
41
+
42
+ - name : Commit and push
43
+ run : |
44
+ git config --global user.name clojure-build
45
+ git config --global user.email "[email protected] "
46
+ git add -u -v
47
+ git commit -m "Action doc commit"
48
+ git push origin master
Original file line number Diff line number Diff line change 1
1
<!DOCTYPE html PUBLIC ""
2
2
"">
3
- < html > < head > < meta charset ="UTF-8 " /> < title > clojure.core.async.flow 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 "> </ span > < span class ="project-version "> </ 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 "> < a href ="flow.html "> < div class ="inner "> < span > core.async.flow #</ span > </ div > </ a > </ li > </ ul > < h3 class ="no-link "> < span class ="inner "> Namespaces</ span > </ h3 > < ul > < li class ="depth-1 "> < a href ="clojure.core.async.html "> < div class ="inner "> < span > clojure.core.async</ span > </ div > </ a > </ li > < li class ="depth-1 current "> < a href ="clojure.core.async.flow.html "> < div class ="inner "> < span > clojure.core.async.flow</ span > </ div > </ a > </ li > < li class ="depth-1 "> < a href ="clojure.core.async.flow.spi.html "> < div class ="inner "> < span > clojure.core.async.flow.spi</ 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 ="clojure.core.async.flow.html#var-command-proc "> < div class ="inner "> < span > command-proc</ span > </ div > </ a > </ li > < li class ="depth-1 "> < a href ="clojure.core.async.flow.html#var-create-flow "> < div class ="inner "> < span > create-flow</ span > </ div > </ a > </ li > < li class ="depth-1 "> < a href ="clojure.core.async.flow.html#var-futurize "> < div class ="inner "> < span > futurize</ span > </ div > </ a > </ li > < li class ="depth-1 "> < a href ="clojure.core.async.flow.html#var-inject "> < div class ="inner "> < span > inject</ span > </ div > </ a > </ li > < li class ="depth-1 "> < a href ="clojure.core.async.flow.html#var-lift*-.3Estep "> < div class ="inner "> < span > lift*->step</ span > </ div > </ a > </ li > < li class ="depth-1 "> < a href ="clojure.core.async.flow.html#var-lift1-.3Estep "> < div class ="inner "> < span > lift1->step</ span > </ div > </ a > </ li > < li class ="depth-1 "> < a href ="clojure.core.async.flow.html#var-pause "> < div class ="inner "> < span > pause</ span > </ div > </ a > </ li > < li class ="depth-1 "> < a href ="clojure.core.async.flow.html#var-pause-proc "> < div class ="inner "> < span > pause-proc</ span > </ div > </ a > </ li > < li class ="depth-1 "> < a href ="clojure.core.async.flow.html#var-ping "> < div class ="inner "> < span > ping</ span > </ div > </ a > </ li > < li class ="depth-1 "> < a href ="clojure.core.async.flow.html#var-ping-proc "> < div class ="inner "> < span > ping-proc</ span > </ div > </ a > </ li > < li class ="depth-1 "> < a href ="clojure.core.async.flow.html#var-process "> < div class ="inner "> < span > process</ span > </ div > </ a > </ li > < li class ="depth-1 "> < a href ="clojure.core.async.flow.html#var-resume "> < div class ="inner "> < span > resume</ span > </ div > </ a > </ li > < li class ="depth-1 "> < a href ="clojure.core.async.flow.html#var-resume-proc "> < div class ="inner "> < span > resume-proc</ span > </ div > </ a > </ li > < li class ="depth-1 "> < a href ="clojure.core.async.flow.html#var-start "> < div class ="inner "> < span > start</ span > </ div > </ a > </ li > < li class ="depth-1 "> < a href ="clojure.core.async.flow.html#var-step-process "> < div class ="inner "> < span > step-process</ span > </ div > </ a > </ li > < li class ="depth-1 "> < a href ="clojure.core.async.flow.html#var-stop "> < div class ="inner "> < span > stop</ span > </ div > </ a > </ li > </ ul > </ div > < div class ="namespace-docs " id ="content "> < h1 class ="anchor " id ="top "> clojure.core.async.flow</ h1 > < div class ="doc "> < pre class ="plaintext ">
3
+ < html > < head > < meta charset ="UTF-8 " /> < title > clojure.core.async.flow 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 "> </ span > < span class ="project-version "> </ 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 "> < a href ="flow.html "> < div class ="inner "> < span > core.async.flow</ span > </ div > </ a > </ li > </ ul > < h3 class ="no-link "> < span class ="inner "> Namespaces</ span > </ h3 > < ul > < li class ="depth-1 "> < a href ="clojure.core.async.html "> < div class ="inner "> < span > clojure.core.async</ span > </ div > </ a > </ li > < li class ="depth-1 current "> < a href ="clojure.core.async.flow.html "> < div class ="inner "> < span > clojure.core.async.flow</ span > </ div > </ a > </ li > < li class ="depth-1 "> < a href ="clojure.core.async.flow.spi.html "> < div class ="inner "> < span > clojure.core.async.flow.spi</ 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 ="clojure.core.async.flow.html#var-command-proc "> < div class ="inner "> < span > command-proc</ span > </ div > </ a > </ li > < li class ="depth-1 "> < a href ="clojure.core.async.flow.html#var-create-flow "> < div class ="inner "> < span > create-flow</ span > </ div > </ a > </ li > < li class ="depth-1 "> < a href ="clojure.core.async.flow.html#var-futurize "> < div class ="inner "> < span > futurize</ span > </ div > </ a > </ li > < li class ="depth-1 "> < a href ="clojure.core.async.flow.html#var-inject "> < div class ="inner "> < span > inject</ span > </ div > </ a > </ li > < li class ="depth-1 "> < a href ="clojure.core.async.flow.html#var-lift*-.3Estep "> < div class ="inner "> < span > lift*->step</ span > </ div > </ a > </ li > < li class ="depth-1 "> < a href ="clojure.core.async.flow.html#var-lift1-.3Estep "> < div class ="inner "> < span > lift1->step</ span > </ div > </ a > </ li > < li class ="depth-1 "> < a href ="clojure.core.async.flow.html#var-pause "> < div class ="inner "> < span > pause</ span > </ div > </ a > </ li > < li class ="depth-1 "> < a href ="clojure.core.async.flow.html#var-pause-proc "> < div class ="inner "> < span > pause-proc</ span > </ div > </ a > </ li > < li class ="depth-1 "> < a href ="clojure.core.async.flow.html#var-ping "> < div class ="inner "> < span > ping</ span > </ div > </ a > </ li > < li class ="depth-1 "> < a href ="clojure.core.async.flow.html#var-ping-proc "> < div class ="inner "> < span > ping-proc</ span > </ div > </ a > </ li > < li class ="depth-1 "> < a href ="clojure.core.async.flow.html#var-process "> < div class ="inner "> < span > process</ span > </ div > </ a > </ li > < li class ="depth-1 "> < a href ="clojure.core.async.flow.html#var-resume "> < div class ="inner "> < span > resume</ span > </ div > </ a > </ li > < li class ="depth-1 "> < a href ="clojure.core.async.flow.html#var-resume-proc "> < div class ="inner "> < span > resume-proc</ span > </ div > </ a > </ li > < li class ="depth-1 "> < a href ="clojure.core.async.flow.html#var-start "> < div class ="inner "> < span > start</ span > </ div > </ a > </ li > < li class ="depth-1 "> < a href ="clojure.core.async.flow.html#var-step-process "> < div class ="inner "> < span > step-process</ span > </ div > </ a > </ li > < li class ="depth-1 "> < a href ="clojure.core.async.flow.html#var-stop "> < div class ="inner "> < span > stop</ span > </ div > </ a > </ li > </ ul > </ div > < div class ="namespace-docs " id ="content "> < h1 class ="anchor " id ="top "> clojure.core.async.flow</ h1 > < div class ="doc "> < pre class ="plaintext ">
4
4
Note - Alpha, work-in-progress, names and other details are in flux
5
5
6
6
A library for building concurrent, event driven data processing
Original file line number Diff line number Diff line change 1
1
<!DOCTYPE html PUBLIC ""
2
2
"">
3
- < html > < head > < meta charset ="UTF-8 " /> < title > clojure.core.async.flow.spi 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 "> </ span > < span class ="project-version "> </ 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 "> < a href ="flow.html "> < div class ="inner "> < span > core.async.flow #</ span > </ div > </ a > </ li > </ ul > < h3 class ="no-link "> < span class ="inner "> Namespaces</ span > </ h3 > < ul > < li class ="depth-1 "> < a href ="clojure.core.async.html "> < div class ="inner "> < span > clojure.core.async</ span > </ div > </ a > </ li > < li class ="depth-1 "> < a href ="clojure.core.async.flow.html "> < div class ="inner "> < span > clojure.core.async.flow</ span > </ div > </ a > </ li > < li class ="depth-1 current "> < a href ="clojure.core.async.flow.spi.html "> < div class ="inner "> < span > clojure.core.async.flow.spi</ 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 ="clojure.core.async.flow.spi.html#var-ProcLauncher "> < div class ="inner "> < span > ProcLauncher</ span > </ div > </ a > </ li > < li class ="depth-2 branch "> < a href ="clojure.core.async.flow.spi.html#var-describe "> < div class ="inner "> < span class ="tree "> < span class ="top "> </ span > < span class ="bottom "> </ span > </ span > < span > describe</ span > </ div > </ a > </ li > < li class ="depth-2 "> < a href ="clojure.core.async.flow.spi.html#var-start "> < div class ="inner "> < span class ="tree "> < span class ="top "> </ span > < span class ="bottom "> </ span > </ span > < span > start</ span > </ div > </ a > </ li > < li class ="depth-1 "> < a href ="clojure.core.async.flow.spi.html#var-Resolver "> < div class ="inner "> < span > Resolver</ span > </ div > </ a > </ li > < li class ="depth-2 branch "> < a href ="clojure.core.async.flow.spi.html#var-get-exec "> < div class ="inner "> < span class ="tree "> < span class ="top "> </ span > < span class ="bottom "> </ span > </ span > < span > get-exec</ span > </ div > </ a > </ li > < li class ="depth-2 "> < a href ="clojure.core.async.flow.spi.html#var-get-write-chan "> < div class ="inner "> < span class ="tree "> < span class ="top "> </ span > < span class ="bottom "> </ span > </ span > < span > get-write-chan</ span > </ div > </ a > </ li > </ ul > </ div > < div class ="namespace-docs " id ="content "> < h1 class ="anchor " id ="top "> clojure.core.async.flow.spi</ h1 > < div class ="doc "> < pre class ="plaintext "> </ pre > </ div > < div class ="public anchor " id ="var-ProcLauncher "> < h3 > ProcLauncher</ h3 > < h4 class ="type "> protocol</ h4 > < div class ="usage "> </ div > < div class ="doc "> < pre class ="plaintext "> Note - defining a ProcLauncher is an advanced feature and should not
3
+ < html > < head > < meta charset ="UTF-8 " /> < title > clojure.core.async.flow.spi 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 "> </ span > < span class ="project-version "> </ 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 "> < a href ="flow.html "> < div class ="inner "> < span > core.async.flow</ span > </ div > </ a > </ li > </ ul > < h3 class ="no-link "> < span class ="inner "> Namespaces</ span > </ h3 > < ul > < li class ="depth-1 "> < a href ="clojure.core.async.html "> < div class ="inner "> < span > clojure.core.async</ span > </ div > </ a > </ li > < li class ="depth-1 "> < a href ="clojure.core.async.flow.html "> < div class ="inner "> < span > clojure.core.async.flow</ span > </ div > </ a > </ li > < li class ="depth-1 current "> < a href ="clojure.core.async.flow.spi.html "> < div class ="inner "> < span > clojure.core.async.flow.spi</ 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 ="clojure.core.async.flow.spi.html#var-ProcLauncher "> < div class ="inner "> < span > ProcLauncher</ span > </ div > </ a > </ li > < li class ="depth-2 branch "> < a href ="clojure.core.async.flow.spi.html#var-describe "> < div class ="inner "> < span class ="tree "> < span class ="top "> </ span > < span class ="bottom "> </ span > </ span > < span > describe</ span > </ div > </ a > </ li > < li class ="depth-2 "> < a href ="clojure.core.async.flow.spi.html#var-start "> < div class ="inner "> < span class ="tree "> < span class ="top "> </ span > < span class ="bottom "> </ span > </ span > < span > start</ span > </ div > </ a > </ li > < li class ="depth-1 "> < a href ="clojure.core.async.flow.spi.html#var-Resolver "> < div class ="inner "> < span > Resolver</ span > </ div > </ a > </ li > < li class ="depth-2 branch "> < a href ="clojure.core.async.flow.spi.html#var-get-exec "> < div class ="inner "> < span class ="tree "> < span class ="top "> </ span > < span class ="bottom "> </ span > </ span > < span > get-exec</ span > </ div > </ a > </ li > < li class ="depth-2 "> < a href ="clojure.core.async.flow.spi.html#var-get-write-chan "> < div class ="inner "> < span class ="tree "> < span class ="top "> </ span > < span class ="bottom "> </ span > </ span > < span > get-write-chan</ span > </ div > </ a > </ li > </ ul > </ div > < div class ="namespace-docs " id ="content "> < h1 class ="anchor " id ="top "> clojure.core.async.flow.spi</ h1 > < div class ="doc "> < pre class ="plaintext "> </ pre > </ div > < div class ="public anchor " id ="var-ProcLauncher "> < h3 > ProcLauncher</ h3 > < h4 class ="type "> protocol</ h4 > < div class ="usage "> </ div > < div class ="doc "> < pre class ="plaintext "> Note - defining a ProcLauncher is an advanced feature and should not
4
4
be needed for ordinary use of the library. This protocol is for
5
5
creating new types of Processes that are not possible to create
6
6
with ::flow/process.
You can’t perform that action at this time.
0 commit comments