search

FormingWorlds / PROTEUS

Coupled atmosphere-interior framework to simulate the temporal evolution of rocky planets.
https://fwl-proteus.readthedocs.io
Apache License 2.0
11 stars 1 forks source link

Move documentation to markdown #119

Closed stefsmeets closed 1 month ago

stefsmeets commented 1 month ago

Just had a short chat with @lsoucasse , we discussed the idea of moving the documentation to markdown with mkdocs. See also the discussion in JANUS: https://github.com/FormingWorlds/JANUS/issues/29

nichollsh commented 1 month ago

I agree that this would be better than the current formulation of the documentation. Is the JANUS one already online?

lsoucasse commented 1 month ago

I agree that this would be better than the current formulation of the documentation. Is the JANUS one already online?

Yes, you can see it on https://fwl-janus.readthedocs.io. For now it only displays the installation instructions that were on the README. Need to complete it with usage/functionalities description.

timlichtenberg commented 1 month ago

Agree as well, it would be good to have a consistent format for the documentation in all modules.

stefsmeets commented 1 month ago

@timlichtenberg could you add me as a maintainer for PROTEUS on readthedocs?

timlichtenberg commented 1 month ago

Added both and Stef.