khanlab / scattr

BIDS app for structural connectivity between targeted regions
https://scattr.readthedocs.io/en/stable/
MIT License
4 stars 3 forks source link

Add readthedocs #52

Closed kaitj closed 1 year ago

kaitj commented 1 year ago

Proposed changes

This PR adds in searchable documentation via readthedocs. From the readthedocs side, I've hidden the latest version, which points to main and instead defaulted the docs to stable, which should always point to the most recently released tagged version. In addition, I've enabled version tagging and activation so that there will be documentation specific to each released version - these tagged versions can be manually removed from the doc sidebar if needed. Lastly, PR builds have been enabled, so there will be a preview of the documentation for each PR.

Also using this PR to fix spelling in the PR template (functionalitiy -> functionality)

Types of changes

What types of changes does your code introduce? Put an x in the boxes that apply

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you are unsure about any of the choices, don't hesitate to ask!

Notes

All PRs will undergo the unit testing before being reviewed. You may be requested to explain or make additional changes before the PR is accepted.

kaitj commented 1 year ago

Should be good for a review now. Some of the images may not render until merged since I put the expected path in. I found that relative paths didn't work in the preview.