bbuenoun / trace-glare

Script to run dynamic glare simulations (DGP) by using Radiance raytracing
Other
0 stars 0 forks source link

Fix API doc generation #11

Closed simon-wacker closed 3 years ago

simon-wacker commented 3 years ago

Extract the API documentation stubs with the tool sphinx-apidoc and generate the HTML documentation with the tool sphinx-build. To generate the documentation run make docs in the project root. It is put in the directory ./docs/html. I added ./docs/source and ./docs/html to .gitignore; the former is generated by sphinx-apidoc and the latter by sphinx-build.

Related to #2