Revise the Spinx workflow

KitwareMedical / ITKPOCUS

An open source library for streaming and preprocessing point-of-care ultrasound video.

Other

19 stars 5 forks source link

Revise the Spinx workflow #12

Closed brad-t-moore closed 3 years ago

brad-t-moore commented 3 years ago

I'm having difficulty getting the out-of- docs/ .md files to render images correctly. I've tried using the myst-parser and m2r2 but the documentation isn't great and they simply aren't working.

thewtex commented 3 years ago

@jcfr may have some tips

jcfr commented 3 years ago

The pull request https://github.com/BICCN/cell-locator/pull/177 from @allemangD added support for building documentation by integrating MyST with sphinx. It was adapted from prior work done by @lassoan in Slicer in https://github.com/Slicer/Slicer/pull/5662 .

Looking at the pull requests above should help you. Especially the first one.

Let us know if you have any questions,