-
-
Notifications
You must be signed in to change notification settings - Fork 424
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[docs] Use of mdinclude directive to add .md files to sphinx docs #291
[docs] Use of mdinclude directive to add .md files to sphinx docs #291
Conversation
Use m2r for the mdinclude directive and recommonmark for everything else, per readthedocs/recommonmark#191 (comment). To make this work, I had to additionally: * Use HTML for any hyperlinks in bold/italics; * Relative link figures from docs directory, i.e. prepend ../../benchmarks/ecg_preprocessing to image paths; and * Remove line blank lines from references div.
Sorry, @DominiqueMakowski; I neglected to target dev branch when opening this PR (I did originally but didn't when re-composing the PR after closing my browser tab). Could you please change the base branch? Also, is there any reason you haven't set dev as your default branch? |
I didn't even know I could do that, thanks a lot haha!
I don't know (GitHub isn't my strength ^^), would it affect the repo in any other way? Before I merge, please consider adding yourself to the contributors |
Codecov Report
@@ Coverage Diff @@
## dev #291 +/- ##
==========================================
+ Coverage 85.45% 85.51% +0.05%
==========================================
Files 156 156
Lines 7116 7116
==========================================
+ Hits 6081 6085 +4
+ Misses 1035 1031 -4
Continue to review full report at Codecov.
|
Neither did I until I made the targetted the wrong branch!
I'm not an authority on this, but it doesn't seem to (aside from affecting |
Indeed, from the discussion, it seems that it would make sense for us to set dev as the default, especially since the last release we try to adopt a feature-PR -> dev workflow and to merge to dev only once a feature is "stable", so I reckon dev is stable enough so that it could work as a default. I'll definitely consider that Anyway, thanks again for your help!! Merging now and welcome onboard 😁 |
Description
Partially resolves #275.
Proposed Changes
Use the
mdinclude
directive of m2r, per readthedocs/recommonmark#191 (comment) for including benchmarks/ecg_preprocessing/README.md on the Benchmarks page. To make this work, I had to additionally:The latter does not break images on the modified README when viewed on GitHub as the relative link coincidentally resolves the same file from both locations.
Checklist
fixed the errorsfoundisort
,black
, andflake8
failed for reasons unrelated to my modifications. Happy to fix but not including in this PR initially.