search

approvals / ApprovalTests.cpp

Native ApprovalTests for C++ on Linux, Mac and Windows
https://approvaltestscpp.readthedocs.io/en/latest/
Apache License 2.0
310 stars 50 forks source link

Bullet lists not rendered correcting on Read the Docs version of our documentation #188

Closed claremacrae closed 2 years ago

claremacrae commented 2 years ago

I just noticed this in https://approvaltestscpp.readthedocs.io/en/latest/generated_docs/TroubleshootingMisconfiguredMain.html:

image

This is what it looks like on GitHub https://github.com/approvals/ApprovalTests.cpp/blob/master/doc/TroubleshootingMisconfiguredMain.md#top:

image

claremacrae commented 2 years ago

When I build the sphinx docs on my machine, they look fine:

image

claremacrae commented 2 years ago

Others have found the same problem:

https://stackoverflow.com/questions/67542699/readthedocs-sphinx-not-rendering-bullet-list-from-rst-file

claremacrae commented 2 years ago

Confirmed as being caused by https://github.com/readthedocs/sphinx_rtd_theme/issues/1115 - I've applied the fix mentioned there of pinning to docutils<0.17 and this has fixed the rendering... Closing issue...

image