pro/con list for sphinx vs. mkdocs

[Frederick, Jennifer M]

Hi all,

 

In advance of this week’s dev telecom, I am sending out a pro/con list I made while trying out two options for pflotran documentation and tutorials (Sphinx and MkDocs). The two versions of a documentation website are located at https://bitbucket.org/pflotran/pflotran-doc-sandbox. For Sphinx, there is also a pdf document of the website. For MkDocs, there is a pdf of the tutorials page only.

I thought we could go over the pro/con list on Wednesday and try to decide where to go next. The list, of course, is based on my experience, and is a collection of what I personally liked or didn’t like about the process of getting a final “product”. Others might have different opinions, especially if you tried it, so it would also be helpful to hear everybody’s input.

 

Jennifer M. Frederick, Ph.D.

Computational Geoscientist/Engineer

Applied Systems Analysis and Research (Org. 6224)

Sandia National Laboratories

Office: 1 (505) 844-3873

Email: jmf...@sandia.gov