datalad / datalad-extension-template

Minimal implementation of a DataLad extension module
http://datalad.org
Other
2 stars 17 forks source link

Update intersphinx_mapping format #59

Closed mslw closed 1 year ago

mslw commented 1 year ago

The "old" format of intersphinx_mapping is deprecated since Sphinx 6.2 and started causing warnings treated as errors in the doc build CI.

https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#confval-intersphinx_mapping

As a side note, the intersphinx extension "can generate links to the documentation of objects in external projects". The changed config option is just an example, even a comment in the file says so. Personally I don't think we need the capability to link to Python project docs by default, and intersphinx could be removed altogether. But since it was here already, and it probably doesn't hurt, it shall remain in an updated format as of this commit.