Add readthedocs #52
Merged
Add readthedocs #52
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kaitj
force-pushed
the
docs
branch
5 times, most recently
from
26bc3b6 to
9061b05
Compare
Collaborator
Author
|
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. |
tkkuehn
requested changes
Apr 20, 2023
Contributor
tkkuehn
left a comment
tkkuehn
left a comment
There was a problem hiding this comment.
This largely looks good, I've mostly noted some typos and stylistic things
kaitj
force-pushed
the
docs
branch
3 times, most recently
from
ae571fe to
2e16a0d
Compare
tkkuehn
approved these changes
Apr 24, 2023
added 11 commits
April 24, 2023 16:31
- installation - docker - singularity
added 20 commits
April 24, 2023 16:31
- relative links did not load in readthedocs - should show up once merged
- remove enlarge feature for dag image
- add labelmerge cli options, allowing for easier swapping of atlases and labelmaps - update documentation FAQ with information about using other atlases - run quality fixes through files - add warning for use of custom atlases - skip use of cortical ribbon as its not needed with convex hull
- add `--skip_labelmerge` argument to allow use of single atlas for targetted structures - add test cases in actions workflow - update faq to reflect changes with `--skip_labelmerge`
- fix pre-prended -> pended - add link to relevant section in bids specification
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed changes
This PR adds in searchable documentation via readthedocs. From the readthedocs side, I've hidden the
latestversion, which points tomainand instead defaulted the docs tostable, 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
xin the boxes that applyChecklist
Put an
xin 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!poe qualitytaskNotes
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.