pradyunsg / furo

A clean customizable documentation theme for Sphinx
https://pradyunsg.me/furo/quickstart
MIT License
2.65k stars 304 forks source link

docs/customisation/edit-button: explain that html_show_sourcelink is ignored #631

Open umarcor opened 1 year ago

umarcor commented 1 year ago

As explained in https://github.com/pradyunsg/furo/discussions/374, html_show_sourcelink is ignored since a year ago. However, it took be a while to find that. Particularly, searching the docs did not provide any result.

This PR adds an explanation to the docs, so that users searching html_show_sourcelink will get some result and can be aware of it.

In order to link to the sphinx docs through intersphinx, I had to add a custom object type. See https://github.com/sphinx-doc/sphinx/issues/5562#issuecomment-434296574.