ucl-sgnl / FSPSimulator

Python Version of the UCL FSP
Apache License 2.0
3 stars 0 forks source link

We need documentation #78

Open CharlesPlusC opened 1 year ago

CharlesPlusC commented 1 year ago

If this going to be open-source and targeting a broad audience I think we need good, clear documentation. We can use SphinX to generate it automatically from the Docstrings but we need to Docstring every function and class in a consistent format to do that.

CharlesPlusC commented 1 year ago

Got a first draft going. It automatically builds from the gh-pages branch at each new push. It is "functional" but super ugly and the images are not displaying. The intro page definitely needs some padding out and improving. I think eventually we also need to include an example section in here with an integrated Jupyter Notebook- that way we have all the examples/docs etc in one same place- this will also avoid users having to download an additional notebook as well as the package itself...