diff --git a/.github/workflows/docs-build-pr.yml b/.github/workflows/docs-build-pr.yml index b88ffad2..f4b70096 100644 --- a/.github/workflows/docs-build-pr.yml +++ b/.github/workflows/docs-build-pr.yml @@ -46,4 +46,4 @@ jobs: - name: Build docs run: | python -m hatch build --hooks-only - make -C docs/ SPHINXOPTS="-W" BUILDDIR="$HOME/docs" OUTDIR="${CURBRANCH:-html}" html + make -C docs/ SPHINXOPTS="-W -v" BUILDDIR="$HOME/docs" OUTDIR="${CURBRANCH:-html}" html diff --git a/.github/workflows/docs-build-update.yml b/.github/workflows/docs-build-update.yml index 1b3aa365..39cc7b1c 100644 --- a/.github/workflows/docs-build-update.yml +++ b/.github/workflows/docs-build-update.yml @@ -49,7 +49,7 @@ jobs: - name: Build docs run: | python -m hatch build --hooks-only - make -C docs/ SPHINXOPTS="-W" BUILDDIR="$HOME/docs" OUTDIR="${CURBRANCH:-html}" html + make -C docs/ SPHINXOPTS="-W -v" BUILDDIR="$HOME/docs" OUTDIR="${CURBRANCH:-html}" html - name: Push created tag to gh-pages if: startsWith(github.ref, 'refs/tags/') diff --git a/README.rst b/README.rst index e22ebc66..c9429946 100644 --- a/README.rst +++ b/README.rst @@ -1,6 +1,6 @@ *Eddymotion* ============ -**Estimating head-motion and deformations derived from eddy-currents in diffusion MRI data**. +Estimating head-motion and deformations derived from eddy-currents in diffusion MRI data. .. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.4680599.svg :target: https://doi.org/10.5281/zenodo.4680599 @@ -47,18 +47,16 @@ 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]_. - .. image:: https://raw.githubusercontent.com/nipreps/eddymotion/507fc9bab86696d5330fd6a86c3870968243aea8/docs/_static/eddymotion-flowchart.svg :alt: The eddymotion 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) + 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 - in diffusion MR imaging, NeuroImage 125 (2016) 1063–1078 + in diffusion MR imaging, NeuroImage 125 (2016) 1063-1078 .. [#r3] M. Cieslak et al., QSIPrep: An integrative platform for preprocessing and reconstructing diffusion MRI data. - Nature Methods, 18(7), 775–778 (2021) + Nature Methods, 18(7), 775-778 (2021) .. [#r4] E. Ozarslan et al., Simple Harmonic Oscillator Based Reconstruction and Estimation for Three-Dimensional Q-Space MRI. in Proc. Intl. Soc. Mag. Reson. Med. vol. 17 1396 (2009) -.. [#r5] E. Garyfallidis et al., Dipy, a library for the analysis of diffusion MRI data. Front. Neuroinformatics 8, 8 - (2014) +.. [#r5] E. Garyfallidis et al., Dipy, a library for the analysis of diffusion MRI data. + Front. Neuroinformatics 8, 8 (2014)