Fix readthedocs

[hshuaib90]

Fixes #252

Currently missing images for tasks. Happy to add those if someone can give them to me.

See https://hazen.readthedocs.io/en/fix-readthedocs/ for working branch

[github-actions]

Coverage Report

File	Stmts	Miss	Cover	Missing
hazenlib
HazenTask.py	24	3	88%	29–31
__init__.py	147	38	74%	135, 139, 149, 154, 191, 198–203, 214, 217–224, 244–246, 264–266, 285–287, 296, 301, 307, 358, 378–380, 388–389, 393
relaxometry.py	317	90	72%	238–256, 630, 689–691, 745, 793–815, 833–848, 1173–1176, 1185–1188, 1200–1213, 1216–1221, 1233–1263
shapes.py	20	9	55%	13, 16, 24–29, 32
snr_map.py	108	5	95%	403, 408–410, 439
tools.py	82	6	93%	43–50, 89
hazenlib/tasks
ghosting.py	150	51	66%	18–32, 47, 109–110, 114, 124–125, 151–153, 170–172, 218–256
relaxometry.py	7	2	71%	10–11
slice_position.py	117	21	82%	31, 40–41, 103–104, 130, 210, 217–233
slice_width.py	359	52	86%	34–37, 107, 166–186, 451, 456–457, 463, 468, 530–531, 780–821
snr.py	163	46	72%	62–67, 221–231, 273–277, 314–327, 332–340, 369–382
snr_map.py	7	7	0%	1–11
spatial_resolution.py	295	90	69%	36–39, 63–121, 134, 219, 255–262, 287, 413–449
task_acr_ghosting.py	116	42	64%	33–53, 91–93, 123–125, 161–194
task_acr_uniformity.py	89	32	64%	34–54, 121–138
uniformity.py	78	19	76%	42–45, 91–92, 99, 133–147
TOTAL	2116	513	76%

Tests	Skipped	Failures	Errors	Time
180	0 💤	0 ❌	0 🔥	2m 52s ⏱️

[heyhaleema]

@Lucrezia-Cester Thanks for offering to add the missing images! This is likely because it was based on the hazen web app repo, so you'll find them here. As discussed, I've had a look at the Read the Docs site and so once this is merged into main, the stable version should build successfully.

@laurencejackson Adding you as an additional reviewer onto this PR since it contains some core hazen commits.

Should we try to set some time aside to clear out the pending PRs?

[Lucrezia-Cester]

Hi, Haleema, thank you for looking at this. @laurencejackson, @heyhaleema, Yup, just let me know when you both have some free time.

[Lucrezia-Cester]

Hi @heyhaleema, sorry for asking you to do extra work, this morning I had a chat with Haris and he asked if the commits related to the readthedocs PR could be placed in a new branch separately?

Let me know if you are up for it otherwise I'll try to do it.

[hshuaib90]

Sorry to clarify, as this branch is for RTD - can the other commits be put into another branch

[heyhaleema]

@hshuaib90 @Lucrezia-Cester I'm happy to do the git rebase and squash/fixup to remove the non-RTD commits from this branch/PR.

@laurencejackson Would you like me to add the non-RTD commits to a new branch, or are these already included in another branch/PR?

@tomaroberts I'll go ahead with discarding your commits in this branch since it seems like they've been merged already.

[heyhaleema]

Looks good 👍

[heyhaleema]

@hshuaib90 I'd approved your changes, but I've just noticed there's a merge conflict with newdocs/source/contributors.rst, so I can re-review once this is resolved.

[Lucrezia-Cester]

Hi @hshuaib90, could you please fix the merge conflict suggested by Haleema?

[hshuaib90]

Thanks for reminder @Lucrezia-Cester . @heyhaleema and I had a chat last week and she is going to fix the conflict.