villano-lab / nrCascadeSim

calculating the NR spectrum resulting from neutron-capture cascades.
MIT License
0 stars 1 forks source link

Sphinx documentation #38

Closed villaa closed 2 years ago

villaa commented 2 years ago

Fix #23 by adding Sphinx documentation that will help our code be more clear and also allow issues to improve documentation.

villaa commented 2 years ago

The Sphinx documentation should also be made visible on readthedocs see the tutorial.

villaa commented 2 years ago

got a rtd account.

villaa commented 2 years ago

Follow the readthedocs tutorial to get the documentation built for this repository. May have to add some elements from the villano-lab-rtd-tutorial repository.