Create Documentation

[lsoucasse]

Create a read the docs page to:

• give installation instructions
• show basic usage/worksflow
• list config file options

Also we could turn the scripts in the example folder into notebooks.

[stefsmeets]

It would be nice to use mkdocs for the documentation: https://www.mkdocs.org/ It's markdown based and compatible with readthedocs.

[nichollsh]

Using Mkdocs sounds great. I personally find restructuredtext quite confusing compared to markdown.

Maybe we could also then use GitHub pages instead of readthedocs.io ?

We could use it for PROTEUS also, maybe?

[timlichtenberg]

I agree, I am also a bit unhappy how convoluted it currently is to edit the Docs. Where would this be hosted?

[nichollsh]

Maybe @stefsmeets can provide more info, but there are details on the MkDocs page describing how to deploy it to GitHub pages. So I think that it would be hosted at something like: https://FormingWorlds.github.io/JANUS/

This is also how AGNI hosts its wiki.

[stefsmeets]

The easiest is to host it on readthedocs or github pages. I slightly favour readthedocs (easier to set up, and has automated versioning), but either works well and is free.

[timlichtenberg]

Which one do you favour...? :>

[stefsmeets]

Oops, readthedocs 🚀