Improve readme and documentation - Githubissues

SCIInstitute / Cleaver

A MultiMaterial Tetrahedral Meshing Library and Application

https://cleaver.readthedocs.io

Other

40 stars 18 forks source link

Improve readme and documentation #123

Closed jcfr closed 1 year ago

jcfr commented 1 year ago

:warning: The merge commit corresponding to this pull-request has been removed from the `master` branch using force push. For more details, see https://github.com/SCIInstitute/Cleaver/pull/126#issue-1708195341

Preview URL
https://cleaver--123.org.readthedocs.build/en/123/

Documentation:

Improve README adding Overview/Method/Documentation/Authors/Acknowledgment/Citing
Improve "Authors" section
Remove empty & unused "Indices and tables" section
Rename "Cleaver2" to "Cleaver" in docstrings and manual
Ensure Copyright year reported in generated documentation is current
Update Cleaver bibliography
Ensure Cleaver is referenced consistently (remove references to Seg3D and ShapeworksStudio)

C++ Code:

Rename "Cleaver2" to "Cleaver" in CLI and GUI applications
Update obsolete documentation URL in GUI application About dialog

Infrastructure:

Fix documentation build warning
Update conf.py updating comments
Cleanup requirements.txt
Convert index from reStructuredText to MyST Markdown

jcfr commented 1 year ago

Thanks for the review, I will finalize some additional tweaks before moving forward with the integration.