Create documentation

[OkonSamuel]

No description provided.

[ablaom]

Okay, a simple readme documentation probably sufficed, but this is awesome! 🎉

I'm not a super expert on Documenter generation, so there may be technical details I'm missing. It looks good to me.

I see that you wrap all the codes in "literal" julia blocks, rather than auto-generating them by using @example or @repl blocks (see here). That's fine, if you have very carefully checked all the code blocks evaluate. Debugging the auto-generating ones can be very tedious, so I don't have a strong opinion.

[ablaom]

We will need to setup secret/deploy keys to enable deployment of the documentation onto gh pages during CI. Let me know if you want me to set that up.

[OkonSamuel]

I see that you wrap all the codes in "literal" julia blocks, rather than auto-generating them by using @example or @repl blocks (see here). That's fine, if you have very carefully checked all the code blocks evaluate. Debugging the auto-generating ones can be very tedious, so I don't have a strong opinion.

Yeah. I just added a few doctests.

[codecov-io]

Codecov Report

Merging #36 (940f6e9) into dev (11f13b1) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##              dev      #36   +/-   ##
=======================================
  Coverage   91.30%   91.30%           
=======================================
  Files           4        4           
  Lines         299      299           
=======================================
  Hits          273      273           
  Misses         26       26           

Impacted Files	Coverage Δ
src/kernels.jl	88.65% <ø> (ø)
src/models.jl	89.28% <ø> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 11f13b1...940f6e9. Read the comment docs.

[OkonSamuel]

We will need to setup secret/deploy keys to enable deployment of the documentation onto gh pages during CI. Let me know if you want me to set that up.

I have done this. But this #PR has to be merged unto dev and then unto master for the documentation to build.
build_docs = (base_ref == "master") && (head_ref == "dev") && (base_repository == head_repository)

[ablaom]

(just FYI: You can leave shuffle=false out, as it's the default; no harm leaving it in for clarity)