Closed jakob-keller closed 2 weeks ago
When calling Sphinx, pass -n -W --keep-going
and set default_role = 'any'
in conf.py
. This will reveal the problems that need to be addressed.
There is also #879. Should conversion to markdown be prioritised over improving RST?
Partially, maybe. You can still enforce strictness in Sphinx. And then, you need to fix the references regardless of which syntax is used.
Additionally, to support inclusion of Markdown files into the Sphinx docs, you'll need to plug MyST-parser there and convert the index document into Markdown (maybe a few more docs, too). I think I have an example of that in pip-tools.
So I'd probably make the conversion depend on everything else...
_Originally posted by @webknjaz in https://github.com/aio-libs/aiobotocore/pull/1160#discussion_r1724142565_