Explore useful Sphinx extensions

[jpmckinney]

See these: https://executablebooks.org/en/latest/tools.html#a-collection-of-sphinx-extensions

• sphinx-copybutton
• sphinx-togglebutton (https://jupyterbook.org/interactive/hiding.html#the-toggle-directive)
  • Use https://sphinx-design.readthedocs.io/en/latest/dropdowns.html instead, if possible
• sphinx-panels (note: the first widgets are not the panels!) https://sphinx-design.readthedocs.io/en/latest/
  • OCDS documentation draft design
• sphinx-inline-tabs (or sphinx-tabs) https://sphinx-design.readthedocs.io/en/rtd-theme/tabs.html
• sphinx-comments e.g. https://jupyterbook.org/interactive/comments/utterances.html
• sphinxcontrib-bibtex (https://jupyterbook.org/content/citations.html)
• sphinx-hoverxref (see Add custom sphinx translator dynamically with a mixin pydata/pydata-sphinx-theme#143)

Other desirable features:

• Visually distinguish internal and external links (maybe possible with CSS only?)
  • If I'm reading the docs consecutively, it's helpful to know which links are to external content.
• Scrollable inline JSON like https://jupyterbook.org/content/layout.html?highlight=scrollable#scrolling-cell-outputs

[jpmckinney]

https://sphinx-hoverxref.readthedocs.io/en/latest/index.html is used a lot in Scrapy docs to preview internal references.