# API documentation in tooltips in Sphinx-generated HTML documentation

**URL:** <https://discuss.python.org/t/api-documentation-in-tooltips-in-sphinx-generated-html-documentation/20986>\
**Category:** Documentation\
**Tags:** documentation\
**Created:** [November 11, 2022, 6:45pm UTC](https://discuss.python.org/t/api-documentation-in-tooltips-in-sphinx-generated-html-documentation/20986 "2022-11-11T18:45:02Z")\
**Posts on this page:** 2\
**Page:** 1

<div class="post-metadata">

**Author:** ![vsajip](https://sea2.discourse-cdn.com/flex002/user_avatar/discuss.python.org/vsajip/32/44_2.png) [@vsajip](https://discuss.python.org/u/vsajip)\
**Post date:** [November 11, 2022, 6:45pm UTC](https://discuss.python.org/t/api-documentation-in-tooltips-in-sphinx-generated-html-documentation/20986/1 "2022-11-11T18:45:03Z")

</div>

I’m implementing a scheme for making API snippets visible in tooltips when browsing Sphinx-generated HTML documentation. At present, it’s implemented in [this Sphinx theme](https://docs.red-dove.com/sphinx_sizzle_theme/index.html#providing-api-tooltips) and there’s a live example of tooltips [here](https://docs.red-dove.com/pagesign/index.html#getting-started) in the “Getting Started” paragraph. It’s early days, and I’m interested in getting feedback on whether this seems like a useful feature and I’m open to any suggestions to improve it.

---

<div class="post-metadata">

**Author:** ![tjreedy](https://sea2.discourse-cdn.com/flex002/user_avatar/discuss.python.org/tjreedy/32/137_2.png) [@tjreedy](https://discuss.python.org/u/tjreedy)\
**Post date:** [November 12, 2022, 5:06am UTC](https://discuss.python.org/t/api-documentation-in-tooltips-in-sphinx-generated-html-documentation/20986/2 "2022-11-12T05:06:45Z")

</div>

I like them as an alternative to jumping down to the reference entry and having to find one’s way back. Having the signature and return should generally make the following example, if any, a bit clearer.