search

jmschrei / yahmm

Yet Another Hidden Markov Model repository.
MIT License
249 stars 32 forks source link

Transitioning documentation to PEP 257 style format #16

Closed tlnagy closed 10 years ago

tlnagy commented 10 years ago

I went ahead and started to transition some of the documentation over to the PEP 257 format, specifically the NumPy/Scipy style. I also added some installation, licensing, and dependency information to the README. The work is only partially complete because I didn't want to invest too much time if this something that you do not prefer.

The desired result, at least in my mind, is to have sphinx generating the documentation (readthedocs integration would be especially nice) with the README containing only an introduction and the installation type information.

Best, -tamas

tlnagy commented 10 years ago

I'm going to go ahead and close this PR because I pushed the master branch. I've created separate branches for docs and tests and I will submit them separately so that it is more manageable for both you all and for me.