search

SABS-R3-projects / Paint4Brains

A brain MRI segmentation tool that provides accurate robust segmentation of problematic brain regions across the neurodegenerative spectrum. The methodology is generalisable to perform well with the typical variance in MRI acquisition parameters and other factors that influence image contrast.
https://www.sabsr3.ox.ac.uk/software-projects
BSD 3-Clause "New" or "Revised" License
10 stars 0 forks source link

Create code documentation & a Wiki #46

Closed AndreiRoibu closed 3 years ago

AndreiRoibu commented 4 years ago

Is your feature request related to a problem? Please describe. Better documentation is required for the code, in particular better docstrings.

Describe the solution you'd like Docstrings need to be created for the code, in a standardised format. Better explanations on what each function/script does needs to be put in place. Sphynx can also be used to generate the documentation required for the code automatically, which can then be used to generate the documentation/wiki.

AndreiRoibu commented 4 years ago

Good explanations on how to use Sphinx and produce docstrings.

https://medium.com/@eikonomega/getting-started-with-sphinx-autodoc-part-1-2cebbbca5365

https://sabs-r3.github.io/module01_se_day4/

AndreiRoibu commented 4 years ago

All code has now been commented and docstrings added to all functions. The code was also reformatted to align to Pep8 standards. Work is currently in the pep8&docs branch, to be merged with the master at a later date.

AndreiRoibu commented 4 years ago

pep8&docs has been merged into master. Currently working on generating documentation.