Adding docs for when docs site is up and improving readme

[thomasgudjonwright]

Starting to improve documentation.

[codecov]

Codecov Report

Merging #36 (2df7f2c) into master (04ab945) will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##            master       #36   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            4         4           
  Lines          158       158           
=========================================
  Hits           158       158           

---

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 04ab945...2df7f2c. Read the comment docs.

[willtebbutt]

LGTM

[github-actions]

[JuliaFormatter] _{reported by reviewdog 🐶}

Suggested change

	pages=["Home" => "index.md", "API" => "api.md",],
	pages=["Home" => "index.md", "API" => "api.md"],

[thomasgudjonwright]

LGTM

Is it obvious to you why the docs are breaking? Is it maybe since the doc site isn't fully set up yet? I wouldn't think that would mean we can't have an api.md set up as we do for when its ready.

[willtebbutt]

I think it might be that, because strict=true, documenter build fails if any warnings are thrown. strict=true is probably good, so we should resolve the warnings.

My suspision is that autodocs is producing a million docstrings for all of the methods of rand etc. You could try building the docs locally with strict=false to see if something is going obviously wrong?

[thomasgudjonwright]

I think it might be that, because strict=true, documenter build fails if any warnings are thrown. strict=true is probably good, so we should resolve the warnings.

My suspision is that autodocs is producing a million docstrings for all of the methods of rand etc. You could try building the docs locally with strict=false to see if something is going obviously wrong?

Bingo, it ran with that change