search

mhoffman / kmos

kMC on steroids: A vigorous attempt to make lattice kinetic Monte Carlo modelling easier
http://mhoffman.github.com/kmos/
GNU General Public License v3.0
53 stars 35 forks source link

Developer's guide in the docs #64

Closed jmlorenzi closed 6 years ago

jmlorenzi commented 6 years ago

Hi Max,

Here is the developer's guide content translated to rst and incorporated into the docs. I had to manually do most of the linking / image inclusion... but now it is done. I have tested that it works locally with Sphinx... I can open the resulting html with my browser locally. However, Travis CI is complaining that the docs are not building. However, this is seems to also be the case for the current master branch.

Let me know what you think. I do not think I will be able to work much on this in the foreseeable future, but I hope to be able to correct obvious mistakes / typos.

Best Juan

mhoffman commented 6 years ago

Hi

thank you very much for this very valuable contribution!

I will fix the build error in the following days.

Cheers, Max.