datalad / datalad-neuroimaging

DataLad extension for neuroimaging research
http://datalad.org
Other
17 stars 14 forks source link

Add extra requirements to RtD config #119

Closed mslw closed 1 year ago

mslw commented 1 year ago

Read the Docs projects created before Oct 20, 2020 (like this one) use Sphinx 1.8.x. New projects use the latest version (docs). Using default build requirements seems to have caused complex dependency conflicts. The only way to override these defaults seems to be through the .readthdocs.yaml config file.

The change introduced here will tell RtD to perform pip install -e. [devel-docs]. This relies on the fact that our setup.cfg already defines a loosely pinned (>=) sphinx dependency. Alternatively, we could introduce a dedicated requirements file for documentation, and use "requirements" key in python.install section (docs). But here we rely on what's already defined.

Closes #117 (see issue comments for details and alternatives).

codecov[bot] commented 1 year ago

Codecov Report

Base: 89.61% // Head: 89.61% // No change to project coverage :thumbsup:

Coverage data is based on head (a00c86e) compared to base (0e7d6ae). Patch has no changes to coverable lines.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #119 +/- ## ======================================= Coverage 89.61% 89.61% ======================================= Files 24 24 Lines 1175 1175 ======================================= Hits 1053 1053 Misses 122 122 ``` Help us with your feedback. Take ten seconds to tell us [how you rate us](https://about.codecov.io/nps?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=datalad). Have a feature suggestion? [Share it here.](https://app.codecov.io/gh/feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=datalad)

:umbrella: View full report at Codecov.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.

mslw commented 1 year ago

Since this is essentially a minor patch extending #118, I feel justified in merging.