It is strongly desired to be able to include the /README.md file in the documentation to
ensure that minimal docs are created for a new project
ensure that basic information is kept synchronized between README and docs
This requires us to be able to read md with Sphinx. Based on recent negative experiences with recommonmark and positive experiences with m2r, we will switch the markdown reader to m2r.
Finally, since m2r (and rst) cannot handle nested markup, we need to switch a couple things about the stock /README.md to remove nested markup, such as in the pypi and travis badges.
It is strongly desired to be able to
includethe /README.md file in the documentation toThis requires us to be able to read md with Sphinx. Based on recent negative experiences with recommonmark and positive experiences with m2r, we will switch the markdown reader to m2r.
Finally, since m2r (and rst) cannot handle nested markup, we need to switch a couple things about the stock /README.md to remove nested markup, such as in the pypi and travis badges.