SeaPearl.jl icon indicating copy to clipboard operation
SeaPearl.jl copied to clipboard

Set up documentation

Open ilancoulon opened this issue 4 years ago • 2 comments

Before/while becoming public, we should set up a nice documentation using Documenter.jl. There are already a lot of comments in the code that should allow the documentation to be quite full very quickly. We just need to write a few pages to explain the overall project (of course using some parts of the paper would be a good idea imo).

ilancoulon avatar Feb 09 '21 10:02 ilancoulon

@PierreTsr

3rdCore avatar Oct 11 '21 19:10 3rdCore

Some important documentation is still missing in some parts of the code. This will be treated in the following weeks.

Also it will be nice to have a working version of the documentation website automatically generated by documenter.jl

3rdCore avatar Feb 15 '22 02:02 3rdCore