I used Sphinx to generate HTML files from the docstrings in the code. You can use restructured text markup in the doctstrings to clarify subjects.
I also added some basic description and documentation. Take a look in the doc folder.
Install sphinx by pip3 install sphinx and from the 'doc' folder, run make html. This will generate the html-files in the doc/build folder. Open up the index.html in you webbrowser and start browsing!
I will still clean up some stuff, but this is already a nice start.
narcode
commented
6 years ago
I used Sphinx to generate HTML files from the docstrings in the code. You can use restructured text markup in the doctstrings to clarify subjects.
I also added some basic description and documentation. Take a look in the
docfolder.Install sphinx by
pip3 install sphinxand from the 'doc' folder, runmake html. This will generate the html-files in thedoc/buildfolder. Open up the index.html in you webbrowser and start browsing!I will still clean up some stuff, but this is already a nice start.