Closed sbellem closed 4 years ago
Appears to be a problem with m2r (markdown to restructuredtext).
m2r
See https://github.com/sphinx-doc/sphinx/issues/7420.
Two possible fixes appear to be:
'm2r @ git+https://github.com/crossnox/m2r@dev#egg=m2r'
recommonmark
Switching to recommonmark appears to be preferable as m2r appears to be non-active in terms of releases.
Assuming the switch does not require much work, then let's try recommonmark.Perhaps there will be difficulties for files such as README.md which are outside the docs/ namespace. See relevant comment: https://github.com/sphinx-doc/sphinx/issues/7420#issuecomment-610156586.
README.md
docs/
Appears to be a problem with
m2r
(markdown to restructuredtext).See https://github.com/sphinx-doc/sphinx/issues/7420.
Two possible fixes appear to be:
m2r
('m2r @ git+https://github.com/crossnox/m2r@dev#egg=m2r'
-- tip taken from https://github.com/sphinx-doc/sphinx/issues/7420#issuecomment-610958327)recommonmark
.Switching to
recommonmark
appears to be preferable asm2r
appears to be non-active in terms of releases.Assuming the switch does not require much work, then let's try
recommonmark
.Perhaps there will be difficulties for files such asREADME.md
which are outside thedocs/
namespace. See relevant comment: https://github.com/sphinx-doc/sphinx/issues/7420#issuecomment-610156586.