FCP-INDI / fcp-indi.github.io

Github Pages Repo for FCP-INDI
https://fcp-indi.github.io
2 stars 8 forks source link

🎨 Use Sphinx start-at/-after and end-at/-before #258

Closed shnizzedy closed 3 years ago

shnizzedy commented 3 years ago

Fixes

Reduces the need to update the pipeline YAML excerpts when changes are made to the default pipeline.

Description

For each default pipeline excerpt, updates the

:lines:

with some combination of

:start-at:
:start-after:
:end-at:
:end-before:
:lines:

so that in the future these excerpts only need to be updated when a line bounding an excerpt changes (a first line or last line of an excerpt or a YAML block immediately before or after an excerpt). Before this change, when a line was added or removed from the default pipeline, the all excerpts that involved code lower in the pipeline (higher line numbers) needed to be updated or the excerpts would shift out of place.

Screenshots

This is the "nightly" docs for anatomical preprocessing before and after this PR:

before after
screenshot of anat screenshot of anat

Checklist

Developer Certificate of Origin

Developer Certificate of Origin ``` Developer Certificate of Origin Version 1.1 Copyright (C) 2004, 2006 The Linux Foundation and its contributors. 1 Letterman Drive Suite D4700 San Francisco, CA, 94129 Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Developer's Certificate of Origin 1.1 By making a contribution to this project, I certify that: (a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or (b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or (c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it. (d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved. ```