search

CrossNox / m2r2

Markdown to reStructuredText converter
https://crossnox.github.io/m2r2
MIT License
107 stars 26 forks source link

README.md into the sphinx docs #45

Closed tweigel-dev closed 2 years ago

tweigel-dev commented 2 years ago

Hello and thanks for the inherited maintaining of m2r! I try to use sphinx for automatic html document generation. Now I like to use markdown to write my README.md. I thought I can use m2r2 to embed the readme into the index.rst of sphinx. So I did the following steps:

But unfortunately nothing happens and the rst remains the same then before. But it got changed if I add some other input into the original rst. Does someone have a clue what can cause this?

Thanks for the support in advance

tweigel-dev commented 2 years ago

okay, at https://stackoverflow.com/questions/46278683/include-my-markdown-readme-into-sphinx I noticed that I have to specify the path with a space before.