Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: Add readthedocs documentation site infrastructure #155

Merged
merged 1 commit into from
Oct 12, 2023

Conversation

jhlegarreta
Copy link
Contributor

@jhlegarreta jhlegarreta commented Sep 16, 2023

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
Copy link
Contributor Author

This supersedes the gh-pages branch.

@jhlegarreta
Copy link
Contributor Author

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

@jhlegarreta jhlegarreta force-pushed the AddReadthedocsDocConfig branch 5 times, most recently from 5462a46 to 275c55e Compare October 5, 2023 16:01
@jhlegarreta
Copy link
Contributor Author

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

@jhlegarreta jhlegarreta force-pushed the AddReadthedocsDocConfig branch 2 times, most recently from 6814abe to a61e634 Compare October 12, 2023 16:48
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 jhlegarreta merged commit 331e5d5 into SlicerDMRI:master Oct 12, 2023
1 of 5 checks passed
@jhlegarreta jhlegarreta deleted the AddReadthedocsDocConfig branch October 12, 2023 17:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants