This PR is kind of large, sorry for not breaking it up, but there are only a few things, and it's all documentation based (I didn't change a single thing outside of a docstring).
All of the scripts in FIRESONG now have docstrings for every function/class/etc
I've included a docs folder with html pages. This was created with pdoc, it's easy to update as we move forwards. If people don't like them or want another theme or something, we can ditch them
We can go into the settings of this repo now and turn on the "pages" feature and link to the docs page, which should make us a nice documentation site
In the future, pages can be regenerated by going to the docs folder and running PYTHONPATH=../ pdoc --config latex_math=True --html ../
I did not do checks for all of the units. Any units that I was unsure of I left a note of UNITS for
This PR is kind of large, sorry for not breaking it up, but there are only a few things, and it's all documentation based (I didn't change a single thing outside of a docstring).
docsfolder with html pages. This was created with pdoc, it's easy to update as we move forwards. If people don't like them or want another theme or something, we can ditch them We can go into the settings of this repo now and turn on the "pages" feature and link to the docs page, which should make us a nice documentation site In the future, pages can be regenerated by going to the docs folder and runningPYTHONPATH=../ pdoc --config latex_math=True --html ../PR targeted at https://github.com/icecube/FIRESONG/issues/16. Still more work to be done for documentation, I just wanted to get it started