Skip to content
This repository has been archived by the owner on Dec 20, 2024. It is now read-only.

Commit

Permalink
DOC: Fix cut passages from README in documentation index file
Browse files Browse the repository at this point in the history
Fix cut passages from `README` in documentation index file: add comments
around the flowchart image in the `README` file and change the
`start-line` and `end-line` directive pair for the `end-before` and
`start-after` pair to skip the flowchart image only.

The `start-line` and `end-line` directives were making such that
relevant passages of the `README` file providing context for the
tool were not being included. Thus the text shown in the documentation
index file had some missing parts, and was not making sense.
  • Loading branch information
jhlegarreta committed Dec 8, 2024
1 parent f10fc12 commit e26943b
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 3 deletions.
4 changes: 4 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,13 @@ More recently, Cieslak et al. [#r3]_ integrated both approaches in *SHORELine*,
the work of ``eddy`` and *SHORELine*, while generalizing these methods to multiple acquisition schemes
(single-shell, multi-shell, and diffusion spectrum imaging) using diffusion models available with DIPY [#r5]_.

.. BEGIN FLOWCHART
.. image:: https://raw.githubusercontent.com/nipreps/eddymotion/507fc9bab86696d5330fd6a86c3870968243aea8/docs/_static/eddymotion-flowchart.svg
:alt: The eddymotion flowchart

.. END FLOWCHART
.. [#r1] S. Ben-Amitay et al., Motion correction and registration of high b-value diffusion weighted images, Magnetic
Resonance in Medicine 67:1694–1702 (2012)
.. [#r2] J. L. R. Andersson. et al., An integrated approach to correction for off-resonance effects and subject movement
Expand Down
5 changes: 2 additions & 3 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
.. include:: links.rst
.. include:: ../README.rst
:end-line: 29
:end-before: BEGIN FLOWCHART
.. include:: ../README.rst
:start-line: 34

:start-after: END FLOWCHART

.. image:: _static/eddymotion-flowchart.svg
:alt: The eddymotion flowchart
Expand Down

0 comments on commit e26943b

Please sign in to comment.