Skip to content
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

Merged
merged 2 commits into from
Jun 28, 2020

Commits on Jun 28, 2020

  1. Example use of mdinclude directive for benchmarks/ecg_preprocessing

    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.
    rpanderson committed Jun 28, 2020
    Configuration menu
    Copy the full SHA
    a8ef240 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    a90f157 View commit details
    Browse the repository at this point in the history