madscatt / zazzie

development branch
GNU General Public License v3.0
2 stars 3 forks source link

compile docstrings for the multi-component analysis module #147

Closed skrueger111 closed 1 year ago

skrueger111 commented 1 year ago

Match point and stoichiometry analysis have docstrings that are fairly complete and Stuhrmann_parallel axis has at least some placeholders. Look again at the docs directory for sasmol (now zazmol under python 3) and set up the same type of directory structure for the multi-component analysis module and compile the docstrings. Get used to making this part of the workflow.

skrueger111 commented 1 year ago

The docs have been written and compiled for all methods except Stuhrmann and parallel axis. A new ticket will be written for this. The new multi-component analysis files and the /docs directory (excluding /docs/build) has been pushed to GitHub. The docs are now tracked files, making docs part of the workflow. There is now a new Wiki describing how the docs directory structure was set up and the docs were compiled.