Merge pull request #238 from nipreps/docs/fix-build

DOC: Fix documentation build
nipreps · Oct 23, 2024 · bcbe011 · bcbe011
2 parents bc48575 + 5fbd32e
commit bcbe011
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 7 deletions.
diff --git 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
@@ -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
@@ -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,11 +47,9 @@ 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)
 .. [#r2] J. L. R. Andersson. et al., An integrated approach to correction for off-resonance effects and subject movement

diff --git a/pyproject.toml b/pyproject.toml
@@ -47,10 +47,10 @@ doc = [
     "packaging",
     "pydot >= 1.2.3",
     "pydotplus",
-    "sphinx >= 4.5",
+    "sphinx >= 4.5, <8",
     "sphinx-argparse",
     "sphinx_rtd_theme",
-    "sphinxcontrib-apidoc ~= 0.3.0",
+    "sphinxcontrib-apidoc",
     "sphinxcontrib-napoleon",
     "sphinxcontrib-versioning",
     "sphinx-argparse",