Embedding documentation content

on YouTube ↗05m

" summary

A hosted API returns HTML fragments and header lists for any published page so web pages or apps can pull exact doc sections; a small JavaScript widget inserts a “show content” button as inline help, and a Sphinx extension called hover xref renders hover previews. A fork of the Python docs demonstrates live pop‑up snippets and full-page embeds as proof of concept, showing the system actually retrieves and displays authored content in place.

AI-written summary · about

" chapters (9)

1. 0:00Intro
2. 0:37Open Source Documentation
3. 0:52Embedding Documentation
4. 2:15API Response
5. 2:35Documentation Interface
6. 2:58Version Documentation
7. 3:20Help Button
8. 3:49Wiki Example
9. 4:03Wikipedia Example

" related talks

• 13mEmbed The Docs!Kristof Van Tomme · Write the Docs North America 2016
• 33mWrite the Docs!Hareem Naveed · PyData Los Angeles 2019
• 45mIntroduction to Sphinx & Read the DocsEric Holscher · Open Source Bridge 2014
• 25mGraphQL Docs: Beyond the SchemaSarah Sanders · GraphQLConf 2024
• 29mIntroduction to Sphinx & Read the DocsEric Holscher · DjangoCon US 2015
• 02h 28mWriting Documentation with Sphinx and reStructuredTextMariatta · PyCon US 2021
• 42mEngineering DocumentationLorna Jane Mitchell · YOW! Melbourne 2022
• 19mWhere Docs, Cloud-hosted Interactive Tutorials and CI Testing IntersectDan Gunter · Write the Docs Portland 2020