SlicerDMRI / whitematteranalysis

White matter tractography clustering and more...
https://dmri.slicer.org/whitematteranalysis/
Other
69 stars 34 forks source link

DOC: Add `readthedocs` documentation site infrastructure #155

Closed jhlegarreta closed 1 year ago

jhlegarreta commented 1 year ago

DOC: Add readthedocs documentation site infrastructure

Add readthedocs documentation site configuration and site index files. Add the necessary packages to generate the documentation from the source files, including Python module methods, and script arguments.

Add Makefile and make.bat files to build the documentation locally.

Add the reference to the readthedocs website and the corresponding build badge to the README file.

jhlegarreta commented 1 year ago

This supersedes the gh-pages branch.

jhlegarreta commented 1 year ago

This fixes the readthedocs build failure concerning the absence of the corresponding config files: https://readthedocs.org/projects/whitematteranalysis/builds/22133730/

jhlegarreta commented 1 year ago

readthedocs build is passing; test, package build failures are unrelated to this patch set.