From a3c1afc6726989cc830595043ce60c7fee03bc7d Mon Sep 17 00:00:00 2001 From: sunoru sidw Date: Wed, 10 Aug 2016 21:34:06 +0800 Subject: [PATCH] Setup for auto deploy. --- .gitignore | 1 + .travis.yml | 1 + docs/.documenter.enc | Bin 0 -> 1680 bytes docs/make.jl | 8 ++++++-- docs/mkdocs.yml | 8 ++++---- docs/src/lib/mersenne-twisters.md | 2 +- docs/src/lib/pcg.md | 2 +- docs/src/lib/rng.md | 1 + docs/src/man/bases.md | 7 +++---- docs/src/man/random123.md | 2 +- docs/src/man/xorshifts.md | 2 +- 11 files changed, 20 insertions(+), 14 deletions(-) create mode 100644 docs/.documenter.enc diff --git a/.gitignore b/.gitignore index d9e1fc1..13829b9 100644 --- a/.gitignore +++ b/.gitignore @@ -7,3 +7,4 @@ actual/ *.log *.so *.dll +/docs/site/ diff --git a/.travis.yml b/.travis.yml index c0a092c..cfc1387 100644 --- a/.travis.yml +++ b/.travis.yml @@ -13,3 +13,4 @@ after_success: - julia -e 'cd(Pkg.dir("RNG")); Pkg.add("Coverage"); using Coverage; Coveralls.submit(Coveralls.process_folder())' # push coverage results to Codecov - julia -e 'cd(Pkg.dir("RNG")); Pkg.add("Coverage"); using Coverage; Codecov.submit(Codecov.process_folder())' + - julia -e 'cd(Pkg.dir("RNG")); Pkg.add("Documenter"); include(joinpath("docs", "make.jl"))' diff --git a/docs/.documenter.enc b/docs/.documenter.enc new file mode 100644 index 0000000000000000000000000000000000000000..fbca45e69dc1a21f258aa16652c0c65a9b203ff5 GIT binary patch literal 1680 zcmV;B25Y(C+t!;0tES%q}7Pfoc9A)sBJskHwl z`x_ygOnu~E;(dx#n<%8b)47KKaYUYbDIR+Zb)ze%vcSxr)3INCC8r?c*s^?^pi!<5 z2T^&1C!IQ;<^k2jzu7Ai-0Voy$8t9~ku@ZX;e9^<6`ihZKzxjv71(d55V>b&9Rma9 zDSXp^M)EL1oGYn6OV&+WDgD8%ln4@(`G@9-x42o2ht<1NfSQ!7kbjl`EPjQIKDs=8 z!_uX&E?Nm>_PlWu*OAi#h$GCLg{TK|qH={gvwU)$JIGzu_G~j31kGZT$K+6cbApTn z7gbjIKcWBg9p7@v6Kj)&s{yL37s47U)96NdMH9q6Gl0frs1y;oyIJXpPn}rW#SX6D zTcQOJuZP@ALUSpNC}0)`qX}FBEw+(Ck))63M9Riun^Ixf`%-$A z%=o&SrnGy^TLh!nTbOZ~n2f_1GaKR0l8FF`3qtJIbRLAYt>g||ox>x@ zuh-c^XB67pVT)L@9HI_)K$T)~HJ!cv6NU zJCC#NNJRfr+_IcQ?Z*E;6$EHR*XKyg9@MP6@e?vX8fbV-cV`dLf~qhRIlMc&EuZYj`)L*>3lYnih|1=)#BV=*)~?RI(32hVi`!H|*@K zb9b7-QVj?gL^FmK@GF!~^zq$G0Or{Zuz+a05EUr_OI@jL&hdEKS!=)&vLPegG!U%1 z(JNM})rHioSCZE~>p~)F5RM#g2zu5U<1?ui~C!o||A!$=Kb?^>t#^29k)GGc59v`G)x_Mv(wFV{am zd;FX3xq47bi&G_(dvCK!xe(DMd-#6bl7}>#`ql6gJ(`OyDxHb=w7wY zMh{}$*3c6h)Fe@SU$->LD4c?nhL=K;L=%11+_SfY62F?WP(v;%H5fx3Y|25reRjF| zVge-^^lxUp@6en&mre;*cB6~_Z5J?I+$js@obWm0nuFr%0;gblQnO-Cn`TMWn)34Y|lLcImv=-p#zI0BCQ8~+JoRWFE>*&rCKuV`qg;mpXFV{LKvv=CvA0L8L?1?;`* z48E3Z2-PIsmM49OLB{XT5KrUrK{ZwRtYaKV`r#SOVJ@X4B@c1ZTY@)mbf_DHwv`Ry zaL|5-_3NSny5sCVq9?>DH2JP&$zpb@Qqw5Os$8KFL{8W8L4xDZaW+{X9$ zDAl>?yQ^Fd8&}(O0)Z)mZ=2+4fyh%7qvo$LO&jkk(&(uOf0qFH!H*+OIjwk=N+v?0 z#?keCoqzGd%(Bq)4C_p)@7#;(0a}D@AEi;m27m9*nDUaXs>lY>4|esH2 af~F^Ih%HcF9%B6y#FFvXDV>BIh4qtXMpaS( literal 0 HcmV?d00001 diff --git a/docs/make.jl b/docs/make.jl index 76952bb..bb839aa 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -1,5 +1,9 @@ using Documenter, RNG -makedocs( - modules = [RNG] +makedocs() + +deploydocs( + deps = Deps.pip("mkdocs", "python-markdown-math", "mkdocs-material"), + repo = "github.com/sunoru/RNG.jl.git", + osname = "linux" ) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 9e23535..158e3f3 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -32,10 +32,10 @@ pages: - Manual: - Bases: man/bases.md - Benchmark: man/benchmark.md - - PCG: man/pcg.md - - MersenneTwisters: man/mersenne-twisters.md - - Random123: man/random123.md - - Xorshifts: man/xorshifts.md + - Permuted Congruential Generators: man/pcg.md + - Mersenne Twisters: man/mersenne-twisters.md + - Random123 Family: man/random123.md + - Xorshift Family: man/xorshifts.md - Library: - RNG: lib/rng.md - PCG: lib/pcg.md diff --git a/docs/src/lib/mersenne-twisters.md b/docs/src/lib/mersenne-twisters.md index f2d5205..f972425 100644 --- a/docs/src/lib/mersenne-twisters.md +++ b/docs/src/lib/mersenne-twisters.md @@ -1 +1 @@ -# Mersenne Twisters +# MersenneTwisters diff --git a/docs/src/lib/pcg.md b/docs/src/lib/pcg.md index d64163e..3aacbf8 100644 --- a/docs/src/lib/pcg.md +++ b/docs/src/lib/pcg.md @@ -1 +1 @@ -# Permuted Congruential Generators +# PCG diff --git a/docs/src/lib/rng.md b/docs/src/lib/rng.md index e69de29..35f24cc 100644 --- a/docs/src/lib/rng.md +++ b/docs/src/lib/rng.md @@ -0,0 +1 @@ +# RNG diff --git a/docs/src/man/bases.md b/docs/src/man/bases.md index 6db0af9..8559550 100644 --- a/docs/src/man/bases.md +++ b/docs/src/man/bases.md @@ -52,14 +52,13 @@ defined in `Base.Random` still work. The constructors of all the types of RNG are designed to take `seed` as their parameters, and can be called with no parameter. For example: -```julia +```jldoctest julia> using RNG.Xorshifts julia> r1 = Xorshift128Star(123) # Create a RNG of Xorshift128Star with the seed "123" RNG.Xorshifts.Xorshift128Star{UInt64}(0x000000003a300074,0x000000003a30004e,0x228e12c83a9b5ed6,false) -julia> r2 = Xorshift128Star() # Use a random value to be the seed. -RNG.Xorshifts.Xorshift128Star{UInt64}(0x784c0ed3d830bb42,0x4d268014e74d6e25,0x4ef0aea8ee776b31,false) +julia> r2 = Xorshift128Star(); # Use a random value to be the seed. julia> rand(r1) # Generate a number uniformly distributed in [0, 1). 0.12555060351645186 @@ -75,7 +74,7 @@ julia> rand!(r1, A) # Refill `A` with random numbers. 0xc0c5a8df4c1b160f 0x8b5269ed6c790e08 0x930b89985ae0c865 ``` -People will get the same results in their own computers of the above lines, except for the third one. For +People will get the same results in their own computers of the above lines. For more interfaces and usage examples, please refer to the manual pages of each RNG. diff --git a/docs/src/man/random123.md b/docs/src/man/random123.md index 6404447..a84bb31 100644 --- a/docs/src/man/random123.md +++ b/docs/src/man/random123.md @@ -1 +1 @@ -# Random123 +# Random123 Family diff --git a/docs/src/man/xorshifts.md b/docs/src/man/xorshifts.md index 6f47d8d..b8fab9c 100644 --- a/docs/src/man/xorshifts.md +++ b/docs/src/man/xorshifts.md @@ -1 +1 @@ -# Xorshifts +# Xorshift Family